OFofficernd
Auth

Sign in a user

Authenticates a member with email and password. On success, returns the signed-in user profile (_id, email, name, image).

Required scopes: flex.user.auth.signin

post/api/v2/organizations/{orgSlug}/auth/signin

Request

  • Base URL
    https://app.officernd.com
  • URL
    https://app.officernd.com/api/v2/organizations/{orgSlug}/auth/signin
  • Auth
    OAuth 2
    Authorization code: https://identity.officernd.com/auth/authorize
    Client credentials
    Token URL: https://identity.officernd.com/auth/token scopes: flex.user.auth.signin

Path parameters

orgSlugstring required

organization slug

Request body

emailstring required

The email which was registered during signup as a login credential.

passwordstring required

The password which was registered during signup as a login credential.

Example request

{
  "email": "example@gmail.com",
  "password": "Pa$$w0rd"
}

Response

_idstring

The _id of the user.

namestring

The display name of the user.

emailstring

The user's primary login email. Omitted when the user has no email.

memberstring nullable

The _id of the member linked to the user in this organization, or null when the user has no linked member.

Example response

{
  "_id": "603dfbc260f4054084125d33",
  "name": "John Doe",
  "email": "john.doe@email.com",
  "member": "603dfbc260f4054084125d30"
}

Changes

No recorded changes to this operation across all 1 revision of this API.