Your suggested change has been received. Thank you.

close

Suggest A Change

https://thales.na.market.dpondemand.io/docs/dpod/services/kmo….

back

DPoD APIs

Users and Credentials API

search

Users and Credentials API

Users and Credentials API

Version: 3.1.5

API Endpoints

Method HTTP request Description
createClient POST /credentials/clients Create client credentials.
deleteClient DELETE /credentials/clients/{id} Delete the client credentials.
getClient GET /credentials/clients/{id} Returns the details of the client credentials associated with the provided client ID.
listClients GET /credentials/clients Returns a list of client credentials.
resetClient POST /credentials/clients/{id}/resetSecret Reset the client credential's secret.
updateClient PATCH /credentials/clients/{id} Update the existing client credentials.
createSubscriberGroups POST /subscriber_groups Create a new Subscriber Group.
deleteSubscriberGroup DELETE /subscriber_groups/{id} Delete a Subscriber Group.
getSubscriberGroup GET /subscriber_groups/{id} Returns the details of a Subscriber Group.
listSubscriberGroups GET /subscriber_groups Returns a list of the Subscriber Groups.
updateSubscriberGroup PATCH /subscriber_groups/{id} Update a Subscriber Group
changeUserPassword PATCH /users/changePassword Update a users password, you must provide the old password.
createUser POST /users Create a User.
deleteUser DELETE /users/{id} Delete a user.
editUserDetails PATCH /users/{id} Update a user's details.
forgotUserPassword POST /users/forgotPassword Create and submit a Forgot Password request and request a Password Reset email.
getUser GET /users/{id} Get the details of a user.
getUserProfile GET /users/profile Returns the details of the current user.
listUsers GET /users Returns a list of the users in the tenant.
resetMfaToken POST /users/{id}/resetMfaToken Update a user's multifactor token.
resetUserPassword PATCH /users/{id}/resetPassword Update a user account with a temporary password.
resetUserPasswordWithCode POST /users/{id}/password Create a new user password after a Forgot Password request was submitted.
sendVerificationEmail POST /users/{id}/sendVerification Send the verify user's email address email to a user.
verifyUserByCode GET /users/{id}/verify Returns a user and verifies the user email address against the one time password code provided in their email.

Models

Authorization

OAuth2

For more information about authorization see Getting Started Using the DPoD API.

  • Type: OAuth
  • Scopes:
    • dpod.tenant.spadmin: Service Provider Administrator
    • dpod.tenant.admin: Tenant Administrator
    • dpod.tenant.appowner: Application Owner
    • dpod.tenant.api_appowner: Application Owner API platform credentials
    • dpod.tenant.api_service: Service credentials
    • dpod.tenant.api_spadmin: Service Provider Administrator API platform credentials