Admin Account Management API
Authentication
This endpoint retrieves a list of all admin users in the system along with their associated roles
Responses
The request was successful, and the response includes a list of all admin users along with their roles and other relevant details
Body
Examples
{
"users": [
{
"id": "0x0000...",
"firstName": "John",
"lastName": "Doe",
"email": "xxxxxxaj@wbd.com",
"roles": [
"CMS_ADMIN",
"LAUNCHPAD_MINTER",
"LAUNCHPAD_APPROVER"
],
"active": true
}
]
}Authentication
This endpoint allows for the creation of a new admin user in the system
Request body
Examples
{
"firstName": "John",
"lastName": "Doe",
"email": "xxxxxxaj@wbd.com",
"roles": [
"CMS_ADMIN",
"LAUNCHPAD_MINTER",
"LAUNCHPAD_APPROVER"
],
"active": false
}Responses
The admin account was successfully created. The response includes the details of the newly created user.
Body
Examples
{
"id": "0x0000...",
"firstName": "John",
"lastName": "Doe",
"email": "xxxxxxaj@wbd.com",
"roles": [
"CMS_ADMIN",
"LAUNCHPAD_MINTER",
"LAUNCHPAD_APPROVER"
],
"active": false
}Authentication
This endpoint updates the details of an existing admin user.
Request body
Examples
{
"firstName": "John",
"lastName": "Doe",
"email": "xxxxxxaj@wbd.com",
"roles": [
"CMS_ADMIN",
"LAUNCHPAD_MINTER",
"LAUNCHPAD_APPROVER"
],
"active": true
}Responses
The admin account was successfully updated. The response includes the details of the updated user.
Body
Authentication
This endpoint updates the details of an existing admin user.
Responses
The admin account was successfully deleted. The response includes the details of the deleted user.
Body
Authentication
This endpoint activates an admin account by setting the Active status to true
Responses
The admin account was successfully enabled
Body
Examples
{
"id": "0x0000...",
"firstName": "John",
"lastName": "Doe",
"email": "xxxxxxaj@wbd.com",
"roles": [
"CMS_ADMIN",
"LAUNCHPAD_MINTER",
"LAUNCHPAD_APPROVER"
],
"active": true
}Authentication
This endpoint deactivates an admin account by setting the Active status to false
Responses
The admin account was successfully disabled
Body
Examples
{
"id": "0x0000...",
"firstName": "John",
"lastName": "Doe",
"email": "xxxxxxaj@wbd.com",
"roles": [
"CMS_ADMIN",
"LAUNCHPAD_MINTER",
"LAUNCHPAD_APPROVER"
],
"active": false
}Authentication
This endpoint grants additional roles to an admin user, enhancing their permissions. The roles are added to the existing set of roles for that user.
Request body
Examples
[
"CMS_ADMIN",
"LAUNCHPAD_MINTER",
"LAUNCHPAD_APPROVER"
]Responses
The roles were successfully added to the admin account. The response includes the updated details of the user with the new roles
Body
Authentication
This endpoint revokes specific roles from an admin user, limiting their permissions within the system. The specified roles are removed from the user’s current roles.
Request body
Examples
[
"CMS_ADMIN",
"LAUNCHPAD_MINTER",
"LAUNCHPAD_APPROVER"
]Responses
The specified roles were successfully removed from the admin account. The response includes the updated details of the user with the remaining roles
Body
A unique identifier for the user
This schema defines the structure and properties of the admin user response object
{
"firstName": "John",
"lastName": "Doe",
"email": "xxxxxxaj@wbd.com",
"roles": [
"CMS_ADMIN",
"LAUNCHPAD_MINTER",
"LAUNCHPAD_APPROVER"
],
"active": true
}The first name of the user
The last name of the user
The email address associated with the user
An array of roles assigned to the user. Roles determine the user’s permissions and access levels within the system. The roles can include CMS_ADMIN, LAUNCHPAD_MINTER, and LAUNCHPAD_APPROVER
A boolean flag indicating whether the user’s account is active
This schema defines the structure and properties of the admin user request object
{
"id": "0x0000...",
"firstName": "John",
"lastName": "Doe",
"email": "xxxxxxaj@wbd.com",
"roles": [
"CMS_ADMIN",
"LAUNCHPAD_MINTER",
"LAUNCHPAD_APPROVER"
],
"active": true
}A unique identifier for the user
The first name of the user
The last name of the user
The email address associated with the user
An array of roles assigned to the user. Roles determine the user’s permissions and access levels within the system. The roles can include CMS_ADMIN, LAUNCHPAD_MINTER, and LAUNCHPAD_APPROVER
A boolean flag indicating whether the user’s account is active
The request was invalid. This might occur if required parameters were missing, incorrectly formatted, or if there were validation errors
Authentication failed. The user credentials provided are invalid or missing
The specified admin account could not be found
There was a conflict in creating the admin user, often due to a unique constraint violation, such as trying to create or update an user with an existing email
Body
Examples
{
"error": "Conflict: Admin account with the provided ID or email already exists."
}An unexpected error occurred on the server