Add service user
2 minute read
POST
Use this endpoint to create a new service user with an API key. To create additional API keys for the same service user, see the Create key endpoint.https://www.digicert.com/services/v2/user
Warning
The API key is shown only this one time in the creation response. It will never be shown again and there is no way to retrieve it if lost.What is service user
A service user has API-only access to your CertCentral account. Only administrators can create servicer users. When creating a service user, you link the administrator’s permissions to the key.
By default, the service user is authorized to perform any actions the administrator can.
Example requests and responses
cURL
curl -X POST \
'https://www.digicert.com/services/v2/user' \
-H 'Content-Type: application/json' \
-H 'X-DC-DEVKEY: {{api_key}}' \
-d '{
"is_api_only": true,
"email": "jane.doe@pd.racoon-city.gov",
"api_name": "API Key Name",
"restricted_to_role_id": 100,
" container_id_assignments": [
12345,
12346
]
}'
201 Created
{
"id": 1538858,
"api_key": "Aqdgb0p5U153195f22s6pw5cj0mfvp06xg89xw0xhh3zhc2"
}
Request parameters
| Name | Req/Opt | Type | Description |
|---|---|---|---|
| is_api_only | required | boolean | If true, the request creates a new service user and returns an API key. |
| required | string | Email address to link to this service user. Some of our processes require the user associated with the API key to have an email address. Accepts only valid email addresses. Character limit: 255 | |
| api_name | required | string | Name of the key. |
| restricted_to_role_id | optional | int | To limit API key permissions, specify the API access role ID. Allowed valued: 0, 100, 101, 102, 103. For more information, see Glossary - API key roles. |
| container_id_assignments | optional | array | List of container IDs (divisions) the service user will be assigned to. If set, this will override any default containers the service user can view. By default, the service user has the same division access as the administrator creating the service user. After creating the service user, you can use the Update user assignments endpoint to update the service user’s container assignments. |
Response parameters
| Name | Type | Description |
|---|---|---|
| id | int | ID of the created service user. |
| api_key | string | Randomly generated API key. |
Was this page helpful?
Provide feedback