--- title: List roles description: Datadog, the leading service for cloud-scale monitoring. breadcrumbs: Docs > API Reference > Roles --- # List roles{% #list-roles %} Copy pageCopied {% tab title="v2" %} | Datadog site | API endpoint | | ----------------- | ---------------------------------------------- | | ap1.datadoghq.com | GET https://api.ap1.datadoghq.com/api/v2/roles | | ap2.datadoghq.com | GET https://api.ap2.datadoghq.com/api/v2/roles | | app.datadoghq.eu | GET https://api.datadoghq.eu/api/v2/roles | | app.ddog-gov.com | GET https://api.ddog-gov.com/api/v2/roles | | us2.ddog-gov.com | GET https://api.us2.ddog-gov.com/api/v2/roles | | app.datadoghq.com | GET https://api.datadoghq.com/api/v2/roles | | us3.datadoghq.com | GET https://api.us3.datadoghq.com/api/v2/roles | | us5.datadoghq.com | GET https://api.us5.datadoghq.com/api/v2/roles | ### Overview Returns all roles, including their names and their unique identifiers. This endpoint requires the `user_access_read` permission. OAuth apps require the `user_access_read` authorization [scope](https://docs.datadoghq.com/api/latest/scopes.md#roles) to access this endpoint. ### Arguments #### Query Strings | Name | Type | Description | | ------------ | ------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | page[size] | integer | Size for a given page. The maximum allowed value is 100. | | page[number] | integer | Specific page number to return. | | sort | enum | Sort roles depending on the given field. Sort order is **ascending** by default. Sort order is **descending** if the field is prefixed by a negative sign, for example: `sort=-name`. Allowed enum values: `name, -name, modified_at, -modified_at, user_count, -user_count` | | filter | string | Filter all roles by the given string. | | filter[id] | string | Filter all roles by the given list of role IDs. | ### Response {% tab title="200" %} OK {% tab title="Model" %} Response containing information about multiple roles. | Parent field | Field | Type | Description | | ------------- | ------------------------- | --------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | | data | [object] | Array of returned roles. | | data | attributes | object | Attributes of the role. | | attributes | created_at | date-time | Creation time of the role. | | attributes | modified_at | date-time | Time of last role modification. | | attributes | name | string | The name of the role. The name is neither unique nor a stable identifier of the role. | | attributes | receives_permissions_from | [string] | The managed role from which this role automatically inherits new permissions. Specify one of the following: "Datadog Admin Role", "Datadog Standard Role", or "Datadog Read Only Role". If empty or not specified, the role does not automatically inherit permissions from any managed role. | | attributes | user_count | int64 | Number of users with that role. | | data | id | string | The unique identifier of the role. | | data | relationships | object | Relationships of the role object returned by the API. | | relationships | permissions | object | Relationship to multiple permissions objects. | | permissions | data | [object] | Relationships to permission objects. | | data | id | string | ID of the permission. | | data | type | enum | Permissions resource type. Allowed enum values: `permissions` | | data | type [*required*] | enum | Roles type. Allowed enum values: `roles` | | | meta | object | Object describing meta attributes of response. | | meta | page | object | Pagination object. | | page | total_count | int64 | Total count. | | page | total_filtered_count | int64 | Total count of elements matched by the filter. | {% /tab %} {% tab title="Example" %} ```json { "data": [ { "attributes": { "created_at": "2019-09-19T10:00:00.000Z", "modified_at": "2019-09-19T10:00:00.000Z", "name": "string", "receives_permissions_from": [], "user_count": "integer" }, "id": "string", "relationships": { "permissions": { "data": [ { "id": "string", "type": "permissions" } ] } }, "type": "roles" } ], "meta": { "page": { "total_count": "integer", "total_filtered_count": "integer" } } } ``` {% /tab %} {% /tab %} {% tab title="403" %} Authentication error {% tab title="Model" %} API error response. | Field | Type | Description | | ------------------------ | -------- | ----------------- | | errors [*required*] | [string] | A list of errors. | {% /tab %} {% tab title="Example" %} ```json { "errors": [ "Bad Request" ] } ``` {% /tab %} {% /tab %} {% tab title="429" %} Too many requests {% tab title="Model" %} API error response. | Field | Type | Description | | ------------------------ | -------- | ----------------- | | errors [*required*] | [string] | A list of errors. | {% /tab %} {% tab title="Example" %} ```json { "errors": [ "Bad Request" ] } ``` {% /tab %} {% /tab %} ### Code Example ##### \# Curl command curl -X GET "https://api.datadoghq.com/api/v2/roles" \ -H "Accept: application/json" \ -H "DD-API-KEY: ${DD_API_KEY}" \ -H "DD-APPLICATION-KEY: ${DD_APP_KEY}" ##### ```python """ List roles returns "OK" response """ from os import environ from datadog_api_client import ApiClient, Configuration from datadog_api_client.v2.api.roles_api import RolesApi # there is a valid "role" in the system ROLE_DATA_ATTRIBUTES_NAME = environ["ROLE_DATA_ATTRIBUTES_NAME"] configuration = Configuration() with ApiClient(configuration) as api_client: api_instance = RolesApi(api_client) response = api_instance.list_roles( filter=ROLE_DATA_ATTRIBUTES_NAME, ) print(response) ``` #### Instructions First [install the library and its dependencies](https://docs.datadoghq.com/api/latest.md?code-lang=python) and then save the example to `example.py` and run following commands: DD_SITE="datadoghq.com" DD_API_KEY="" DD_APP_KEY="" python3 "example.py" ##### ```ruby # List roles returns "OK" response require "datadog_api_client" api_instance = DatadogAPIClient::V2::RolesAPI.new # there is a valid "role" in the system ROLE_DATA_ATTRIBUTES_NAME = ENV["ROLE_DATA_ATTRIBUTES_NAME"] opts = { filter: ROLE_DATA_ATTRIBUTES_NAME, } p api_instance.list_roles(opts) ``` #### Instructions First [install the library and its dependencies](https://docs.datadoghq.com/api/latest.md?code-lang=ruby) and then save the example to `example.rb` and run following commands: DD_SITE="datadoghq.com" DD_API_KEY="" DD_APP_KEY="" rb "example.rb" ##### ```go // List roles returns "OK" response package main import ( "context" "encoding/json" "fmt" "os" "github.com/DataDog/datadog-api-client-go/v2/api/datadog" "github.com/DataDog/datadog-api-client-go/v2/api/datadogV2" ) func main() { // there is a valid "role" in the system RoleDataAttributesName := os.Getenv("ROLE_DATA_ATTRIBUTES_NAME") ctx := datadog.NewDefaultContext(context.Background()) configuration := datadog.NewConfiguration() apiClient := datadog.NewAPIClient(configuration) api := datadogV2.NewRolesApi(apiClient) resp, r, err := api.ListRoles(ctx, *datadogV2.NewListRolesOptionalParameters().WithFilter(RoleDataAttributesName)) if err != nil { fmt.Fprintf(os.Stderr, "Error when calling `RolesApi.ListRoles`: %v\n", err) fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) } responseContent, _ := json.MarshalIndent(resp, "", " ") fmt.Fprintf(os.Stdout, "Response from `RolesApi.ListRoles`:\n%s\n", responseContent) } ``` #### Instructions First [install the library and its dependencies](https://docs.datadoghq.com/api/latest.md?code-lang=go) and then save the example to `main.go` and run following commands: DD_SITE="datadoghq.com" DD_API_KEY="" DD_APP_KEY="" go run "main.go" ##### ```java // List roles returns "OK" response import com.datadog.api.client.ApiClient; import com.datadog.api.client.ApiException; import com.datadog.api.client.v2.api.RolesApi; import com.datadog.api.client.v2.api.RolesApi.ListRolesOptionalParameters; import com.datadog.api.client.v2.model.RolesResponse; public class Example { public static void main(String[] args) { ApiClient defaultClient = ApiClient.getDefaultApiClient(); RolesApi apiInstance = new RolesApi(defaultClient); // there is a valid "role" in the system String ROLE_DATA_ATTRIBUTES_NAME = System.getenv("ROLE_DATA_ATTRIBUTES_NAME"); try { RolesResponse result = apiInstance.listRoles( new ListRolesOptionalParameters().filter(ROLE_DATA_ATTRIBUTES_NAME)); System.out.println(result); } catch (ApiException e) { System.err.println("Exception when calling RolesApi#listRoles"); System.err.println("Status code: " + e.getCode()); System.err.println("Reason: " + e.getResponseBody()); System.err.println("Response headers: " + e.getResponseHeaders()); e.printStackTrace(); } } } ``` #### Instructions First [install the library and its dependencies](https://docs.datadoghq.com/api/latest.md?code-lang=java) and then save the example to `Example.java` and run following commands: DD_SITE="datadoghq.com" DD_API_KEY="" DD_APP_KEY="" java "Example.java" ##### ```rust // List roles returns "OK" response use datadog_api_client::datadog; use datadog_api_client::datadogV2::api_roles::ListRolesOptionalParams; use datadog_api_client::datadogV2::api_roles::RolesAPI; #[tokio::main] async fn main() { // there is a valid "role" in the system let role_data_attributes_name = std::env::var("ROLE_DATA_ATTRIBUTES_NAME").unwrap(); let configuration = datadog::Configuration::new(); let api = RolesAPI::with_config(configuration); let resp = api .list_roles(ListRolesOptionalParams::default().filter(role_data_attributes_name.clone())) .await; if let Ok(value) = resp { println!("{:#?}", value); } else { println!("{:#?}", resp.unwrap_err()); } } ``` #### Instructions First [install the library and its dependencies](https://docs.datadoghq.com/api/latest.md?code-lang=rust) and then save the example to `src/main.rs` and run following commands: DD_SITE="datadoghq.com" DD_API_KEY="" DD_APP_KEY="" cargo run ##### ```typescript /** * List roles returns "OK" response */ import { client, v2 } from "@datadog/datadog-api-client"; const configuration = client.createConfiguration(); const apiInstance = new v2.RolesApi(configuration); // there is a valid "role" in the system const ROLE_DATA_ATTRIBUTES_NAME = process.env .ROLE_DATA_ATTRIBUTES_NAME as string; const params: v2.RolesApiListRolesRequest = { filter: ROLE_DATA_ATTRIBUTES_NAME, }; apiInstance .listRoles(params) .then((data: v2.RolesResponse) => { console.log( "API called successfully. Returned data: " + JSON.stringify(data) ); }) .catch((error: any) => console.error(error)); ``` #### Instructions First [install the library and its dependencies](https://docs.datadoghq.com/api/latest.md?code-lang=typescript) and then save the example to `example.ts` and run following commands: DD_SITE="datadoghq.com" DD_API_KEY="" DD_APP_KEY="" tsc "example.ts" {% /tab %}