User info
4 minute read
GET
Use this endpoint to get details about a user.https://www.digicert.com/services/v2/user/{{user_id}}
Note
You can replace{{user_id}} with me in the endpoint URL to get details about the user assigned to the API key used for the request.Example requests and responses
curl -X GET \
https://www.digicert.com/services/v2/user/{{user_id}} \
-H 'Content-Type: application/json' \
-H 'X-DC-DEVKEY: {{api_key}}'import requests
url = "https://www.digicert.com/services/v2/user/{{user_id}}"
headers = {
'X-DC-DEVKEY': "{{api_key}}",
'Content-Type': "application/json"
}
response = requests.request("GET", url, headers=headers)
print(response.text)package main
import (
"fmt"
"net/http"
"io/ioutil"
)
func main() {
url := "https://www.digicert.com/services/v2/user/{{user_id}}"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("X-DC-DEVKEY", "{{api_key}}")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := ioutil.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}var request = require("request");
var options = { method: 'GET',
url: 'https://www.digicert.com/services/v2/user/{{user_id}}',
headers:
{ 'Content-Type': 'application/json',
'X-DC-DEVKEY': '{{api_key}}' } };
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});200 OK
{
"id": 125039,
"username": "john.smith@digicert.com",
"account_id": 123654,
"first_name": "John",
"last_name": "Smith",
"email": "john.smith@digicert.com",
"job_title": "Sys Admin",
"telephone": "555-555-5555",
"status": "active",
"last_login_date": "2019-06-21 13:37:00",
"container": {
"id": 5,
"public_id": "9bba0f54e97e31abb0f2a7e6e9386f1",
"name": "My Account",
"parent_id": 0,
"template_id": 5,
"ekey": "<ekey>",
"has_logo": true,
"is_active": true
},
"access_roles": [
{
"id": 1,
"name": "Administrator"
}
],
"is_cert_central": true,
"is_enterprise": true,
"is_saml_sso_only": false,
"type": "standard",
"language_id": 1,
"account_language_id": 1,
"has_container_assignments": false,
"container_visibility": [
{
"id": 5,
"public_id": "9bba0f54e97e31abb0f2a7e6e9386f1",
"name": "My Account",
"parent_id": 0,
"template_id": 5,
"ekey": "<ekey>",
"has_logo": true,
"is_active": true
},
{
"id": 94317,
"public_id": "049991aead2691319b7f8c536af186",
"name": "Support",
"parent_id": 0,
"template_id": 6,
"ekey": "<ekey>",
"has_logo": false,
"is_active": true,
"allowed_domain_names": [
"example.com"
],
"organization_assignments": [
{
"id": 11,
"name": "Organization Name"
}
]
}
]
}
Response parameters
| Name | Type | Description |
|---|---|---|
| id | int | ID of the user. |
| username | string | Username used to sign in. |
| account_id | int | CertCentral account ID. |
| first_name | string | First name of user. |
| last_name | string | Last name of user. |
| string | Email address of user. | |
| job_title | string | Job title of the user. |
| telephone | string | Telephone number of the user. |
| status | string | Current status of the user. See Glossary – User status. |
| last_login_date | string | Timestamp of the last time the user signed in. Format: |
| yyyy-MM-dd HH:mm:ss | ||
| container | object | Info about the user’s container association. |
| .. id | int | Container ID. |
| .. public_id | string | Public ID of the container. |
| .. name | string | Name of the container. |
| .. parent_id | int | ID of the parent container. |
| .. template_id | int | ID of the template assigned to the container. |
| .. ekey | string | Unique key used for custom branding. |
| .. has_logo | bool | Custom logo status for container. |
| .. is_active | bool | Active status of the container. |
| access_roles | array | Access role assigned to the user. See Glossary – Access roles. |
| .. id | int | Access role ID. |
| .. name | string | Name of the access role. |
| is_cert_central | bool | Whether the user has a CertCentral account. |
| is_enterprise | bool | Whether the user belongs to an enterprise account. |
| is_saml_sso_only | bool | If true, the user can only log in to CertCentral via SAML SSO. Otherwise, false. |
| type | string | User type. Possible values: |
| standard | ||
| language_id | int | ID of the language used for content the user sees in their CertCentral account. Possible values: See Glossary – Locale codes. |
| account_language_id | int | ID of the language used in notification emails from CertCentral. Possible values:Glossary – Locale codes |
| has_container_assignments | bool | If true, the user has specific container assignments, and the response includes a container_assignments array. Otherwise, false. |
| container_assignments | array | List of containers to which the user is assigned. Only returned if the user has container assignments. |
| .. id | int | ID of the assigned container. |
| .. parent_id | int | ID of the parent container. |
| .. name | string | Name of the assigned container. |
| .. is_active | bool | Status of the assigned container. |
| container_visibility | array | List of containers visible to the user. |
| .. id | int | Container ID. |
| .. public_id | string | Public ID of the container. |
| .. name | string | Name of the container. |
| .. parent_id | int | ID of the parent container. |
| .. template_id | int | ID of the template assigned to the container. |
| .. ekey | string | Unique key used for custom branding. |
| .. has_logo | bool | Custom logo status for container. |
| .. is_active | bool | Active status of the container. |
| .. allowed_domain_names | array | List of domains that can be used with the container. |
| .. organization_assignments | array | List of organizations that can be used with the container. |
| .. .. id | int | Organization ID. |
| .. .. name | string | Legal name of the organization. |
Was this page helpful?
Provide feedback