API Reference
Create a User
/v1/usersAuthorization
bearerAuth In: header
Request Body
application/json
Create a User
TypeScript Definitions
Use the request body type in TypeScript.
Response Body
application/json
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
/v1/usersAuthorization
bearerAuth In: header
Query Parameters
Range size of returned list.
1 <= value <= 1000100Starting point for the list of entries.
Response Body
application/json
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
/v1/users/{id}Authorization
bearerAuth In: header
Path Parameters
User ID
uuidResponse Body
application/json
application/json
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
/v1/users/{id}Authorization
bearerAuth In: header
Path Parameters
User ID
uuidRequest Body
application/json
Update a User
TypeScript Definitions
Use the request body type in TypeScript.
Response Body
application/json
application/json
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
/v1/users/{id}Authorization
bearerAuth In: header
Path Parameters
User ID
uuidResponse Body
application/json
application/json
curl -X DELETE "https://example.com/v1/users/497f6eca-6276-4993-bfeb-53cbbbba6f08"Search Users
/v1/users/searchAuthorization
bearerAuth In: header
Request Body
application/json
The search criteria
TypeScript Definitions
Use the request body type in TypeScript.
Response Body
application/json
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
/v1/users/{userId}/credentialsAuthorization
bearerAuth In: header
Path Parameters
User ID
uuidQuery Parameters
Range size of returned list.
1 <= value <= 1000100Starting point for the list of entries.
Response Body
application/json
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"}How would you rate this page?
Last updated on