Create a User

POST/v1/users

Create a user.

USER_CREATE_START
USER_CREATE_SUCCESS
USER_CREATE_FAIL

Authorization

bearerAuth

AuthorizationBearer <token>

In: header

Request Body

application/json

Create a User

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

`application/json`

curl -X POST "https://example.com/v1/users" \  -H "Content-Type: application/json" \  -d '{}'

{  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",  "claims": {},  "authenticationProvider": {    "providerId": "string",    "url": "string",    "subjectId": "string"  }}

POST/v1/users

Create a user.

USER_CREATE_START
USER_CREATE_SUCCESS
USER_CREATE_FAIL

Authorization

bearerAuth

AuthorizationBearer <token>

In: header

Request Body

application/json

Create a User

TypeScript Definitions

Use the request body type in TypeScript.

claims?

User claims to be persisted. No claims are persisted by default. Consider PII implications before persisting any claims.

authenticationProvider?

Authentication Provider information for the user. This enables linking the user to an external identity provider. If implemented insecurely, this process can be exploited by malicious actors to gain unauthorized access to legitimate user accounts.

To mitigate this risk, require authentication for both accounts involved in the link, whether the link is created manually or automatically. Always prompt the user to enter credentials to verify ownership before establishing the link.

Response Body

`application/json`

curl -X POST "https://example.com/v1/users" \  -H "Content-Type: application/json" \  -d '{}'

{  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",  "claims": {},  "authenticationProvider": {    "providerId": "string",    "url": "string",    "subjectId": "string"  }}

Roles

Authorization

Request Body

Response Body

`application/json`

`application/json`

Create a User

Roles

Authorization

Request Body

Response Body

`application/json`

`application/json`

Create a User

Roles

Authorization

Request Body

Response Body

201application/json

400application/json

Create a User

Roles

Authorization

Request Body

Response Body

201application/json

400application/json

`application/json`

`application/json`

`application/json`

`application/json`