Administrators
Administrators API overview
The Administrators API allows integrators to manage SCM administrator accounts and their associated access settings.
The API supports the following actions:
- Creating and modifying administrators.
- Retrieving available roles and privileges.
- Managing identity provider links.
- Updating passwords and account states.
Administrators API endpoints
The following table lists the endpoints for managing SCM administrators.
Click any action in the first column to open its API reference page.
| Action | Method | Path | Description |
|---|---|---|---|
| Get administrator details | GET | /api/admin/v1/{id} | Retrieve details for a specific administrator. |
| Update an administrator | PUT | /api/admin/v1/{id} | Update administrator information such as roles or account attributes. |
| Delete an administrator | DELETE | /api/admin/v1/{id} | Delete an administrator account. |
| Unlink an IdP administrator from a template | PUT | /api/admin/v1/{id}/unlink | Unlink an administrator account from its IdP template mapping. |
| List administrators | GET | /api/admin/v1 | Retrieve a list of all administrators. |
| Create an administrator | POST | /api/admin/v1 | Create a new administrator account. |
| Change password | POST | /api/admin/v1/changepassword | Change the password for an administrator account. |
| Get available roles | GET | /api/admin/v1/roles | Retrieve a list of available administrator roles. |
| Get available privileges | GET | /api/admin/v1/privileges | Retrieve a list of available access privileges for administrators. |
| Get password state | GET | /api/admin/v1/password | Retrieve the password state for an administrator (for example, ALIVE, EXPIRED). |
| Get list of Identity Providers | GET | /api/admin/v1/idp | List available Identity Providers (IdPs) configured for the tenant. |
Updated about 20 hours ago