Skip to content
Authrim

Authenticate with a directory password and create a managed browser session.

POST
/api/auth/directory-password/login
Code sample: Shell / cURL 
curl --request POST \
  --url https://auth.example.com/api/auth/directory-password/login \
  --header 'Content-Type: application/json' \
  --data '{ "username": "alice", "password": "correct-horse-battery-staple", "invite_token": "invite-token-if-admin-invitation-fallback-is-required" }'

Request Body required

Section titled “Request Body required ”
Media type application/json
object
username
required
string
>= 1 characters
password
required
string format: password
invite_token

Optional tenant invitation token used only to authorize admin-invitation-only migration fallback.

string
>= 1 characters
authorization_challenge_id
string
>= 1 characters
human_verification_response
string
>= 1 characters
key
additional properties
Example 
{
  "username": "alice",
  "password": "correct-horse-battery-staple",
  "invite_token": "invite-token-if-admin-invitation-fallback-is-required"
}

Responses

Section titled “ Responses ”

200

Section titled “200 ”

Successful JSON response.

Media type application/json
One of:
object
ok
required
boolean
expires_in
required
integer
session
required
object
userId
string
createdAt
integer
expiresAt
integer
authTime
integer
acr
string
amr
Array<string>
key
additional properties
user
required
object
id
string
email
string format: email
name
Any of:
string
authorization
object
key
additional properties
redirect_url
string format: uri
Example 
{
  "ok": true,
  "expires_in": 86400,
  "session": {
    "userId": "user_123",
    "createdAt": 1770000000000,
    "expiresAt": 1770086400000,
    "authTime": 1770000000,
    "acr": "urn:mace:incommon:iap:bronze",
    "amr": [
      "pwd",
      "directory"
    ]
  },
  "user": {
    "id": "user_123",
    "email": "[email protected]",
    "name": "Example User"
  }
}