Custom Sign In API

Version: v1

Check the username/password of a user

POST/api/account/login

Example Request

{
   "username": "[email protected]",
   "password": "",
   "persistent": false,
   "rememberUserName": true,
   "tenant": "my-tenant",
   "clientId": "my-app-id"
}

Parameters

Name	Description
`username`* required string (body)
`password`* required string (body)
`persistent` boolean (body)
`rememberUserName` boolean (body)
`tenant` string (body)
`acrValues` string (body)
`clientId`* required string (body)
`authRequest` (body)
`cookiesEnabled` boolean (body)

Responses

200

If the request was successful. May not indicate the user was signed in completely

{
   "sessionToken": null,
   "stateToken": null,
   "next": "done",
   "principal": ,
   "items": null
}

Name	Type	Description	Format
sessionToken	string
stateToken	string
next	string
principal
items	object

400

If the username or password was incorrect. Or some other user-facing error occurred

{
   "type": null,
   "identifier": "",
   "message": null,
   "responseCode": null,
   "errors": null
}

Name	Type	Format
type	string
identifier	string	uuid
message	string
responseCode	string
errors	array

401

If the user is not allowed to sign in currently

403

Forbidden

{
   "type": null,
   "identifier": "",
   "message": null,
   "responseCode": null,
   "errors": null
}

Name	Type	Format
type	string
identifier	string	uuid
message	string
responseCode	string
errors	array

GET/api/account/login-resume

Parameters

Name Description

Name	Description
`token` string (query)

token

string

(query)

Responses

200

POST/api/account/login-persist

Example Request

Parameters

Name Description

Name	Description
`stateToken` string (body)
`persistent` boolean (body)
`rememberKeepMeSignIn` boolean (body)

stateToken

string

(body)

persistent

boolean

(body)

rememberKeepMeSignIn

boolean

(body)

Responses

200

NoAccessRedirect

GET/no-access-callback

Parameters

Name Description

Name	Description
`state` string (query)

state

string

(query)

Responses

200

OpDashboard

GET/_/op-dashboard

Parameters

Name	Description

Responses

200

ProfileRedirect

GET/profile

Parameters

Name	Description
`tenant` string (query)
`client_id` string (query)
`redirect_uri` string (query)
`state` string (query)

Responses

200

ResetPassword

POST/api/account/update-expired-password

Example Request

{
   "password": "",
   "stateToken": "",
   "clientId": "",
   "tenant": ""
}

Parameters

Name	Description
`password`* required string (body)
`stateToken`* required string (body)
`clientId`* required string (body)
`tenant`* required string (body)

Login

Example Request

Parameters

Responses

200

400

401

403

Parameters

Responses

200

Example Request

Parameters

Responses

200

NoAccessRedirect

Parameters

Responses

200

OpDashboard

Parameters

Responses

200

ProfileRedirect

Parameters

Responses

200

ResetPassword

Example Request

Parameters

Responses

200