List users

GET https://www.digicert.com/services/v2/user

Use this endpoint to list all account users. Results can be filtered to a specific container using the container_id URL query string.

Notice

Change the ACCEPT header to text/csv to return a CSV output of the results.

Example requests and responses

Example 1. cURL

curl -X GET \
  'https://www.digicert.com/services/v2/user' \
  -H 'Content-Type: application/json' \
  -H 'X-DC-DEVKEY: {{api_key}}'

Example 2. Python

import requests

url = "https://www.digicert.com/services/v2/user"

headers = {
    'X-DC-DEVKEY': "{{api_key}}",
    'Content-Type': "application/json"
    }

response = requests.request("GET", url, headers=headers)

print(response.text)

Example 3. Go

package main

import (
    "fmt"
    "net/http"
    "io/ioutil"
)

func main() {

    url := "https://www.digicert.com/services/v2/user"

    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))

}

Example 4. NodeJS

var request = require("request");

var options = { method: 'GET',
  url: 'https://www.digicert.com/services/v2/user',
  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);
});

Example 5. 200 OK

{
  "users": [
    {
      "id": 125038,
      "username": "jane.doe@digicert.com",
      "account_id": <account_id>,
      "first_name": "Jane",
      "last_name": "Doe",
      "email": "jane.doe@digicert.com",
      "job_title": "Boss",
      "telephone": "555-555-5555",
      "status": "active",
      "container": {
        "id": 5,
        "public_id": "<public_id>",
        "name": "Company",
        "parent_id": 0,
        "template_id": 4,
        "ekey": "<ekey>",
        "has_logo": false,
        "is_active": true
      },
      "access_roles": [
        {
          "id": 1,
          "name": "Administrator"
        }
      ],
      "type": "standard",
      "has_container_assignments": false
    },
    {
      "id": 125039,
      "username": "john.smith@digicert.com",
      "account_id": <account_id>,
      "first_name": "John",
      "last_name": "Smith",
      "email": "john.smith@digicert.com",
      "job_title": "Employee",
      "telephone": "555-555-5555",
      "status": "active",
      "container": {
        "id": 5,
        "public_id": "<public_id>",
        "name": "Company",
        "parent_id": 0,
        "template_id": 4,
        "ekey": "<ekey>",
        "has_logo": false,
        "is_active": true
      },
      "access_roles": [
        {
          "id": 5,
          "name": "Standard User"
        }
      ],
      "type": "standard",
      "has_container_assignments": true,
      "container_assignments": [
        {
          "id": <container_id>,
          "parent_id": <parent_container_id>,
          "name": <container_name>,
          "is_active": true
      ]
    }
  ],
  "page": {
    "total": 2,
    "limit": 1000,
    "offset": 0
  }
}

Filters and URL query parameters

This endpoint supports filters, sorting, and pagination. For general information and examples of the syntax to use when applying filters and sorting results, see Services API - Filters, sorting, and pagination parameters.

Name	Req/Opt	Type	Description
container_id	optional	int	Filter results to the specified container.
access_role_id	optional	int	Limit results to users with a given access role. Possible values: See Glossary – Access roles.
without_container	optional	boolean	If true, response omits the `container` object for each returned user. Default: false
filters[`{{property_name}}`]	optional	string	Filters results by the specified property. Replace `{{property_name}}` in your request with the property to use for filtering. This endpoint supports filtering by the following properties: `filters[status]`: See Glossary – User status.
filters[search]	optional	string	Limits response to results where the value of the `username`, `first_name`, `last_name`, or `email` property matches or contains a specific string of characters. To search for values that contain a specific string of characters, prefix the string with a URL encoded (percent-encoded) % character: `%25`. To search for values that are an exact match for a string of characters, omit the `%25` from the request. Examples: `filters[search]=%25gmail` Limits response to results where the value of a searched property contains the string `gmail`. `filters[search]=myname@gmail.com` Limits response to results where the value of a searched property is an exact match for the string `myname@gmail.com`.
sort	optional	string	Sorts results by the value of one or more properties. By default, sorts results in ascending alphabetical order (0-9, A-Z). To sort in descending alphabetical order (9-0, Z-A), prefix the property name with a minus (`-`). To sort by multiple properties, separate the name of each property with a comma. Sort hierarchy matches the order of properties in this list. This endpoint supports sorting by the following properties: `id` `username` `first_name` `last_name` `email` `telephone` `job_title` `status` `last_login_date` `container_id`
offset	optional	int	Index of the first result to include in the response.
limit	optional	int	Total number of results to include in the response.

Response parameters

Name	Type	Description
users	array	List of all users returned by the request.
.. id	int	User ID.
.. username	string	String used to log in.
.. account_id	int	CertCentral account ID.
.. first_name	string	User first name.
.. last_name	string	User last name.
.. email	string	User email address.
.. job_title	string	User job title.
.. telephone	string	User phone number.
.. status	string	User account status. See Glossary – User status.
.. container	object	Details about the primary account container. Omitted if request URL includes the query string `without_container=true`.
.. .. id	int	ID of the primary account container.
.. .. public_id	string	Public ID for the primary account container.
.. .. name	string	Name of the primary account container.
.. .. parent_id	int	Parent ID of the primary account container.
.. .. template_id	int	ID of the template the container is using.
.. .. 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	Details about user's assigned access role.
.. .. id	int	ID of the access role. See Glossary – Access roles.
.. .. name	string	Name of the access role. See Glossary – Access roles.
.. type	string	Defines the user account type.
.. has_container_assignments	bool	Container assignment status. If `true` returns `container_assignments` array.
.. container_assignments	array	Details about the user's 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.
page	object	Details about results. Modified using URL query strings.

In this section: