Skip to content

datadog list-roles

Returns all roles or specific role detail

Description

Returns all roles or specific role detail

Synopsis

datadog list-roles
    [--site <site>]
    [--role <role>]
    [--size <size>]
    [--number <number>]
    [--sort <sort>]
    [--filter <filter>]

Arguments

site - (string)

     Site where this command will be executed
     Example: --site "site-1"
     Default: input.site      Attributes: optional

role - (string)

     The unique identifier of the role
     Example: --role "role-1"
     Default: _None_      Attributes: optional

size - (int)

     Size for a given page. The maximum allowed value is 5000
     Example: --size 1
     Default: _None_      Attributes: optional

     Validation:
         max: 5000

number - (int)

     Specific page number to return
     Example: --number 1
     Default: _None_      Attributes: optional

sort - (string)

     Sort roles depending on the given field. Use negative for descending
     Example: --sort "sort-1"
     Default: _None_      Attributes: optional

     Validation:
         allowed values: name, -name, modified_at, -modified_at, user_count, -user_count

filter - (string)

     Filter all roles by the given string
     Example: --filter "filter-1"
     Default: _None_      Attributes: optional

Examples

Input: 

!datadog list-roles
Output: 
ID                                      TYPE    NAME                    USERS
ba26c340-82a9-11ed-b5cb-da7ad0900005    roles   Datadog Admin Role          1
ba36c25e-82a9-11ed-b5cb-da7ad0900005    roles   Datadog Read Only Role      0
ba30590a-82a9-11ed-b5cb-da7ad0900005    roles   Datadog Standard Role       0

Access Control

To use this command, you need access to the following:

Field Value
Action "read"
Service Type "datadog"
Service Instance
Namespace
Object Type "permission"
Object ID

Please see Access Control for details.