Skip to content

Login with password

Request

Authenticate a user with a password

Bodyapplication/jsonrequired
usernamestring

The user's username. Pass either username or email, but not both.

emailstring

The user's primary email address. Pass either username or email, but not both.

phone_numberstring

The user's primary phone number. Pass only one of username, email, or phone_number, but not both.

identifier_typestring

Type of user identifier used for login

identifierstring

User identifier, which may correspond to the user's email, phone number, username, or user ID. The type of identifier should be specified as the identifier_type.

passwordstringrequired

The user's password

client_idstringrequired

Client ID of the application requesting authentication, retrieved from the Transmit Admin Portal

Example:"c35ab2a.xVShlOVGsUMh3Cqk73K1O.transmit"
redirect_uristringrequired

URI to redirect to upon completion of the IDP flow. This is the server GET endpoint used to call the token endpoint, and should accept "code" as a query parameter. This URI must also be configured as an allowed redirect URI in the Transmit Admin Portal.

Example:"https://domain.com/verify"
resourcestring

Resource URI the login is attempting to access.

require_mfaboolean

Require multi-factor authentication for this authentication request.

Default:false
Example:true
claimsobject

Used to request additional claims in the ID token, such as roles, permissions, and other user profile data. The structure is per the OIDC Standard. For supported claims and how to request custom claims, see the ID Token Reference.

Example:
{
  "id_token": {
    "roles": null
  }
}
org_idstring

Organization ID, used for member login in B2B scenarios

curl -i -X POST \
  https://api.sbx.transmitsecurity.io/cis/v1/auth/password/login \
  -H 'Content-Type: application/json' \
  -d '{
    "username": "string",
    "email": "string",
    "phone_number": "string",
    "identifier_type": "string",
    "identifier": "string",
    "password": "string",
    "client_id": "c35ab2a.xVShlOVGsUMh3Cqk73K1O.transmit",
    "redirect_uri": "https://domain.com/verify",
    "resource": "string",
    "require_mfa": true,
    "claims": {
      "id_token": {
        "roles": null
      }
    },
    "org_id": "string"
  }'

Responses

Bodyapplication/json
resultobjectrequired
Response
{
  "result": {
    "url": "string"
  }
}