API Reference

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"  }}

Retrieve all Users

GET/v1/users

Authorization

bearerAuth

AuthorizationBearer <token>

In: header

Query Parameters

limit?number

Range size of returned list.

Range1 <= value <= 1000

Default100

cursor?string

Starting point for the list of entries.

Response Body

`application/json`

curl -X GET "https://example.com/v1/users"

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

Retrieve a User

GET/v1/users/{id}

Authorization

bearerAuth

AuthorizationBearer <token>

In: header

Path Parameters

id*string

User ID

Formatuuid

Response Body

`application/json`

curl -X GET "https://example.com/v1/users/497f6eca-6276-4993-bfeb-53cbbbba6f08"

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

Update a User

PUT/v1/users/{id}

Authorization

bearerAuth

AuthorizationBearer <token>

In: header

Path Parameters

id*string

User ID

Formatuuid

Request Body

application/json

Update 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?

Response Body

`application/json`

curl -X PUT "https://example.com/v1/users/497f6eca-6276-4993-bfeb-53cbbbba6f08" \  -H "Content-Type: application/json" \  -d '{}'

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

Delete a User

DELETE/v1/users/{id}

Authorization

bearerAuth

AuthorizationBearer <token>

In: header

Path Parameters

id*string

User ID

Formatuuid

Response Body

`application/json`

curl -X DELETE "https://example.com/v1/users/497f6eca-6276-4993-bfeb-53cbbbba6f08"

Empty

Search Users

POST/v1/users/search

Authorization

bearerAuth

AuthorizationBearer <token>

In: header

Request Body

application/json

The search criteria

TypeScript Definitions

Use the request body type in TypeScript.

claims?

Filter users by claims. Nested objects are supported. Text values must be an exact match.

authenticationProvider?

Filter users by their unique identifier in the configured Authentication Provider.

limit?number

Range size of returned entries, default 100

Range1 <= value <= 1000

cursor?string

Starting point for the range of entries

Response Body

`application/json`

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

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

Retrieve User credentials Data

GET/v1/users/{userId}/credentials

Authorization

bearerAuth

AuthorizationBearer <token>

In: header

Path Parameters

userId*string

User ID

Formatuuid

Query Parameters

limit?number

Range size of returned list.

Range1 <= value <= 1000

Default100

cursor?string

Starting point for the list of entries.

Response Body

`application/json`

curl -X GET "https://example.com/v1/users/497f6eca-6276-4993-bfeb-53cbbbba6f08/credentials"

{  "data": [    {      "id": "string",      "type": "string",      "profile": "mobile",      "offerId": "string",      "sessionId": "string",      "credentialConfigurationId": "string",      "devicePublicKey": {        "kty": "string",        "crv": "string",        "x": "string"      },      "namespaces": {},      "msoHash": "string",      "issuedDate": "2019-08-24T14:15:22Z",      "validFrom": "2019-08-24T14:15:22Z",      "validUntil": "2019-08-24T14:15:22Z",      "status": "valid"    }  ],  "nextCursor": "string"}

201application/json

400application/json

200application/json

400application/json

200application/json

400application/json

404application/json

200application/json

400application/json

404application/json

204

400application/json

404application/json

200application/json

400application/json

200application/json

400application/json

On this page

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`