GET https://api.ap1.datadoghq.com/api/v2/permissions https://api.ap2.datadoghq.com/api/v2/permissions https://api.datadoghq.eu/api/v2/permissions https://api.ddog-gov.com/api/v2/permissions https://api.us2.ddog-gov.com/api/v2/permissions https://api.datadoghq.com/api/v2/permissions https://api.us3.datadoghq.com/api/v2/permissions https://api.us5.datadoghq.com/api/v2/permissions
Overview Returns a list of all permissions, including name, description, and ID.
This endpoint requires the user_access_read permission.
OAuth apps require the user_access_read authorization scope to access this endpoint.
Response OK
Payload with API-returned permissions.
Expand All
Attributes of a permission.
Creation time of the permission.
Description of the permission.
Displayed name for the permission.
Name of the permission group.
List of alias names for the permission.
Whether or not the permission is restricted.
Permissions resource type.
Allowed enum values: permissions
default: permissions
{
"data" : [
{
"attributes" : {
"created" : "2019-09-19T10:00:00.000Z" ,
"description" : "string" ,
"display_name" : "string" ,
"display_type" : "string" ,
"group_name" : "string" ,
"name" : "string" ,
"name_aliases" : [],
"restricted" : false
},
"id" : "string" ,
"type" : "permissions"
}
]
} Bad Request
{
"errors" : [
"Bad Request"
]
} Authentication error
{
"errors" : [
"Bad Request"
]
} Too many requests
{
"errors" : [
"Bad Request"
]
} Code Example Copy
# Curl command curl -X GET "https://api.ap1.datadoghq.com "https://api.ap2.datadoghq.com "https://api.datadoghq.eu "https://api.ddog-gov.com "https://api.us2.ddog-gov.com "https://api.datadoghq.com "https://api.us3.datadoghq.com "https://api.us5.datadoghq.com /api/v2/permissions " \
-H "Accept: application/json" \
-H "DD-API-KEY: ${DD_API_KEY} " \
-H "DD-APPLICATION-KEY: ${DD_APP_KEY} "
"""
List permissions returns "OK" response
"""
from datadog_api_client import ApiClient , Configuration
from datadog_api_client.v2.api.roles_api import RolesApi
configuration = Configuration ()
with ApiClient ( configuration ) as api_client :
api_instance = RolesApi ( api_client )
response = api_instance . list_permissions ()
print ( response )
Instructions First install the library and its dependencies and then save the example to example.py and run following commands:
DD_SITE = "datadoghq.com us3.datadoghq.com us5.datadoghq.com datadoghq.eu ap1.datadoghq.com ap2.datadoghq.com ddog-gov.com us2.ddog-gov.com " DD_API_KEY = "<DD_API_KEY>" DD_APP_KEY = "<DD_APP_KEY>" python3 "example.py"
# List permissions returns "OK" response
require "datadog_api_client"
api_instance = DatadogAPIClient :: V2 :: RolesAPI . new
p api_instance . list_permissions ()
Instructions First install the library and its dependencies and then save the example to example.rb and run following commands:
DD_SITE = "datadoghq.com us3.datadoghq.com us5.datadoghq.com datadoghq.eu ap1.datadoghq.com ap2.datadoghq.com ddog-gov.com us2.ddog-gov.com " DD_API_KEY = "<DD_API_KEY>" DD_APP_KEY = "<DD_APP_KEY>" rb "example.rb"
// List permissions 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 () {
ctx := datadog . NewDefaultContext ( context . Background ())
configuration := datadog . NewConfiguration ()
apiClient := datadog . NewAPIClient ( configuration )
api := datadogV2 . NewRolesApi ( apiClient )
resp , r , err := api . ListPermissions ( ctx )
if err != nil {
fmt . Fprintf ( os . Stderr , "Error when calling `RolesApi.ListPermissions`: %v\n" , err )
fmt . Fprintf ( os . Stderr , "Full HTTP response: %v\n" , r )
}
responseContent , _ := json . MarshalIndent ( resp , "" , " " )
fmt . Fprintf ( os . Stdout , "Response from `RolesApi.ListPermissions`:\n%s\n" , responseContent )
}
Instructions First install the library and its dependencies and then save the example to main.go and run following commands:
DD_SITE = "datadoghq.com us3.datadoghq.com us5.datadoghq.com datadoghq.eu ap1.datadoghq.com ap2.datadoghq.com ddog-gov.com us2.ddog-gov.com " DD_API_KEY = "<DD_API_KEY>" DD_APP_KEY = "<DD_APP_KEY>" go run "main.go"
// List permissions 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.model.PermissionsResponse ;
public class Example {
public static void main ( String [] args ) {
ApiClient defaultClient = ApiClient . getDefaultApiClient ();
RolesApi apiInstance = new RolesApi ( defaultClient );
try {
PermissionsResponse result = apiInstance . listPermissions ();
System . out . println ( result );
} catch ( ApiException e ) {
System . err . println ( "Exception when calling RolesApi#listPermissions" );
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 and then save the example to Example.java and run following commands:
DD_SITE = "datadoghq.com us3.datadoghq.com us5.datadoghq.com datadoghq.eu ap1.datadoghq.com ap2.datadoghq.com ddog-gov.com us2.ddog-gov.com " DD_API_KEY = "<DD_API_KEY>" DD_APP_KEY = "<DD_APP_KEY>" java "Example.java"
// List permissions returns "OK" response
use datadog_api_client ::datadog ;
use datadog_api_client ::datadogV2 ::api_roles ::RolesAPI ;
#[tokio::main]
async fn main () {
let configuration = datadog ::Configuration ::new ();
let api = RolesAPI ::with_config ( configuration );
let resp = api . list_permissions (). await ;
if let Ok ( value ) = resp {
println! ( " {:#?} " , value );
} else {
println! ( " {:#?} " , resp . unwrap_err ());
}
}
Instructions First install the library and its dependencies and then save the example to src/main.rs and run following commands:
DD_SITE = "datadoghq.com us3.datadoghq.com us5.datadoghq.com datadoghq.eu ap1.datadoghq.com ap2.datadoghq.com ddog-gov.com us2.ddog-gov.com " DD_API_KEY = "<DD_API_KEY>" DD_APP_KEY = "<DD_APP_KEY>" cargo run
/**
* List permissions returns "OK" response
*/
import { client , v2 } from "@datadog/datadog-api-client" ;
const configuration = client . createConfiguration ();
const apiInstance = new v2 . RolesApi ( configuration );
apiInstance
. listPermissions ()
. then (( data : v2.PermissionsResponse ) => {
console . log (
"API called successfully. Returned data: " + JSON . stringify ( data )
);
})
. catch (( error : any ) => console . error ( error ));
Instructions First install the library and its dependencies and then save the example to example.ts and run following commands:
DD_SITE = "datadoghq.com us3.datadoghq.com us5.datadoghq.com datadoghq.eu ap1.datadoghq.com ap2.datadoghq.com ddog-gov.com us2.ddog-gov.com " DD_API_KEY = "<DD_API_KEY>" DD_APP_KEY = "<DD_APP_KEY>" tsc "example.ts"