Users and Credentials API
Version: 3.1.5
API Endpoints
| Request | Summary |
|---|---|
| POST /v1/credentials/clients | Create client credentials. |
| DELETE /v1/credentials/clients/{id} | Delete the client credentials. |
| GET /v1/credentials/clients/{id} | Returns the details of the client credentials associated with the provided client ID. |
| GET /v1/credentials/clients | Returns a list of client credentials. |
| POST /v1/credentials/clients/{id}/resetSecret | Reset the client credential's secret. |
| PATCH /v1/credentials/clients/{id} | Update the existing client credentials. |
| POST /v1/subscriber_groups | Create a new Subscriber Group. |
| DELETE /v1/subscriber_groups/{id} | Delete a Subscriber Group. |
| GET /v1/subscriber_groups/{id} | Returns the details of a Subscriber Group. |
| GET /v1/subscriber_groups | Returns a list of the Subscriber Groups. |
| PATCH /v1/subscriber_groups/{id} | Update a Subscriber Group |
| PATCH /v1/users/changePassword | Update a users password, you must provide the old password. |
| POST /v1/users | Create a User. |
| DELETE /v1/users/{id} | Delete a user. |
| PATCH /v1/users/{id} | Update a user's details. |
| POST /v1/users/forgotPassword | Create and submit a Forgot Password request and request a Password Reset email. |
| GET /v1/users/{id} | Get the details of a user. |
| GET /v1/users/profile | Returns the details of the current user. |
| GET /v1/users | Returns a list of the users in the tenant. |
| POST /v1/users/{id}/resetMfaToken | Update a user's multifactor token. |
| PATCH /v1/users/{id}/resetPassword | Update a user account with a temporary password. |
| POST /v1/users/{id}/password | Create a new user password after a Forgot Password request was submitted. |
| POST /v1/users/{id}/sendVerification | Send the verify user's email address email to a user. |
| GET /v1/users/{id}/verify | Returns a user and verifies the user email address against the one time password code provided in their email. |
Authorization
OAuth2
For more information about authorization see Getting Started Using the DPoD API.
- Type: OAuth
- Scopes:
- dpod.tenant.spadmin: Service Provider Administrator user role. Used to access the user interface.
- dpod.tenant.admin: Tenant Administrator user role. Used to access the user interface.
- dpod.tenant.appowner: Application Owner user role. Used to access the user interface.
- dpod.tenant.spadmin.unverified: Unverified Service Provider Administrator temporary user role. Used to access the user interface during account verification.
- dpod.tenant.admin.unverified: Unverified Tenant Administrator temporary user role. Used to access the user interface during account verification.
- dpod.tenant.appowner.unverified: Unverified Application Owner temporary user role. Used to access the user interface during account verification.
- dpod.tenant.api_spadmin: Service Provider Administrator API role. Used for application authentication over the API, the API role provides a subset of dpod.tenant.spadmin permissions to an application.
- dpod.tenant.api_appowner: Tenant Administrator and Application Owner API role. Used for application authentication over the API, the API role provides a subset of dpod.tenant.appowner and dpod.tenant.admin permissions to an application.
- dpod.tenant.api_service: Service API role. Used for application authentication over the API, the API role provides a subset of dpod.tenant.appowner and dpod.tenant.admin permissions to an application.