Whether the user is a service account. Must be true.
title
string
The title of the user.
relationships
object
Relationships of the user object.
roles
object
Relationship to roles.
data
[object]
An array containing type and the unique identifier of a role.
id
string
The unique identifier of the role.
type
enum
Roles type.
Allowed enum values: roles
type [required]
enum
Users resource type.
Allowed enum values: users
{"data":{"type":"users","attributes":{"name":"Test API Client","email":"Example-Service-Account@datadoghq.com","service_account":true},"relationships":{"roles":{"data":[{"id":"string","type":"roles"}]}}}}
// Create a service account returns "OK" response
packagemainimport("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")funcmain(){// there is a valid "role" in the system
RoleDataID:=os.Getenv("ROLE_DATA_ID")body:=datadogV2.ServiceAccountCreateRequest{Data:datadogV2.ServiceAccountCreateData{Type:datadogV2.USERSTYPE_USERS,Attributes:datadogV2.ServiceAccountCreateAttributes{Name:datadog.PtrString("Test API Client"),Email:"Example-Service-Account@datadoghq.com",ServiceAccount:true,},Relationships:&datadogV2.UserRelationships{Roles:&datadogV2.RelationshipToRoles{Data:[]datadogV2.RelationshipToRoleData{{Id:datadog.PtrString(RoleDataID),Type:datadogV2.ROLESTYPE_ROLES.Ptr(),},},},},},}ctx:=datadog.NewDefaultContext(context.Background())configuration:=datadog.NewConfiguration()apiClient:=datadog.NewAPIClient(configuration)api:=datadogV2.NewServiceAccountsApi(apiClient)resp,r,err:=api.CreateServiceAccount(ctx,body)iferr!=nil{fmt.Fprintf(os.Stderr,"Error when calling `ServiceAccountsApi.CreateServiceAccount`: %v\n",err)fmt.Fprintf(os.Stderr,"Full HTTP response: %v\n",r)}responseContent,_:=json.MarshalIndent(resp,""," ")fmt.Fprintf(os.Stdout,"Response from `ServiceAccountsApi.CreateServiceAccount`:\n%s\n",responseContent)}
// Create a service account returns "OK" response
importcom.datadog.api.client.ApiClient;importcom.datadog.api.client.ApiException;importcom.datadog.api.client.v2.api.ServiceAccountsApi;importcom.datadog.api.client.v2.model.RelationshipToRoleData;importcom.datadog.api.client.v2.model.RelationshipToRoles;importcom.datadog.api.client.v2.model.RolesType;importcom.datadog.api.client.v2.model.ServiceAccountCreateAttributes;importcom.datadog.api.client.v2.model.ServiceAccountCreateData;importcom.datadog.api.client.v2.model.ServiceAccountCreateRequest;importcom.datadog.api.client.v2.model.UserRelationships;importcom.datadog.api.client.v2.model.UserResponse;importcom.datadog.api.client.v2.model.UsersType;importjava.util.Collections;publicclassExample{publicstaticvoidmain(String[]args){ApiClientdefaultClient=ApiClient.getDefaultApiClient();ServiceAccountsApiapiInstance=newServiceAccountsApi(defaultClient);// there is a valid "role" in the system
StringROLE_DATA_ID=System.getenv("ROLE_DATA_ID");ServiceAccountCreateRequestbody=newServiceAccountCreateRequest().data(newServiceAccountCreateData().type(UsersType.USERS).attributes(newServiceAccountCreateAttributes().name("Test API Client").email("Example-Service-Account@datadoghq.com").serviceAccount(true)).relationships(newUserRelationships().roles(newRelationshipToRoles().data(Collections.singletonList(newRelationshipToRoleData().id(ROLE_DATA_ID).type(RolesType.ROLES))))));try{UserResponseresult=apiInstance.createServiceAccount(body);System.out.println(result);}catch(ApiExceptione){System.err.println("Exception when calling ServiceAccountsApi#createServiceAccount");System.err.println("Status code: "+e.getCode());System.err.println("Reason: "+e.getResponseBody());System.err.println("Response headers: "+e.getResponseHeaders());e.printStackTrace();}}}
"""
Create a service account returns "OK" response
"""fromosimportenvironfromdatadog_api_clientimportApiClient,Configurationfromdatadog_api_client.v2.api.service_accounts_apiimportServiceAccountsApifromdatadog_api_client.v2.model.relationship_to_role_dataimportRelationshipToRoleDatafromdatadog_api_client.v2.model.relationship_to_rolesimportRelationshipToRolesfromdatadog_api_client.v2.model.roles_typeimportRolesTypefromdatadog_api_client.v2.model.service_account_create_attributesimportServiceAccountCreateAttributesfromdatadog_api_client.v2.model.service_account_create_dataimportServiceAccountCreateDatafromdatadog_api_client.v2.model.service_account_create_requestimportServiceAccountCreateRequestfromdatadog_api_client.v2.model.user_relationshipsimportUserRelationshipsfromdatadog_api_client.v2.model.users_typeimportUsersType# there is a valid "role" in the systemROLE_DATA_ID=environ["ROLE_DATA_ID"]body=ServiceAccountCreateRequest(data=ServiceAccountCreateData(type=UsersType.USERS,attributes=ServiceAccountCreateAttributes(name="Test API Client",email="Example-Service-Account@datadoghq.com",service_account=True,),relationships=UserRelationships(roles=RelationshipToRoles(data=[RelationshipToRoleData(id=ROLE_DATA_ID,type=RolesType.ROLES,),],),),),)configuration=Configuration()withApiClient(configuration)asapi_client:api_instance=ServiceAccountsApi(api_client)response=api_instance.create_service_account(body=body)print(response)
# Create a service account returns "OK" responserequire"datadog_api_client"api_instance=DatadogAPIClient::V2::ServiceAccountsAPI.new# there is a valid "role" in the systemROLE_DATA_ID=ENV["ROLE_DATA_ID"]body=DatadogAPIClient::V2::ServiceAccountCreateRequest.new({data:DatadogAPIClient::V2::ServiceAccountCreateData.new({type:DatadogAPIClient::V2::UsersType::USERS,attributes:DatadogAPIClient::V2::ServiceAccountCreateAttributes.new({name:"Test API Client",email:"Example-Service-Account@datadoghq.com",service_account:true,}),relationships:DatadogAPIClient::V2::UserRelationships.new({roles:DatadogAPIClient::V2::RelationshipToRoles.new({data:[DatadogAPIClient::V2::RelationshipToRoleData.new({id:ROLE_DATA_ID,type:DatadogAPIClient::V2::RolesType::ROLES,}),],}),}),}),})papi_instance.create_service_account(body)
/**
* Create a service account returns "OK" response
*/import{client,v2}from"@datadog/datadog-api-client";constconfiguration=client.createConfiguration();constapiInstance=newv2.ServiceAccountsApi(configuration);// there is a valid "role" in the system
constROLE_DATA_ID=process.env.ROLE_DATA_IDasstring;constparams: v2.ServiceAccountsApiCreateServiceAccountRequest={body:{data:{type:"users",attributes:{name:"Test API Client",email:"Example-Service-Account@datadoghq.com",serviceAccount: true,},relationships:{roles:{data:[{id: ROLE_DATA_ID,type:"roles",},],},},},},};apiInstance.createServiceAccount(params).then((data: v2.UserResponse)=>{console.log("API called successfully. Returned data: "+JSON.stringify(data));}).catch((error: any)=>console.error(error));
Response for retrieving a partial application key.
Expand All
フィールド
種類
説明
data
object
Partial Datadog application key.
attributes
object
Attributes of a partial application key.
created_at
string
Creation date of the application key.
last4
string
The last four characters of the application key.
name
string
Name of the application key.
scopes
[string]
Array of scopes to grant the application key. This feature is in private beta, please contact Datadog support to enable scopes for your application keys.
{"data":{"attributes":{"created_at":"2020-11-23T10:00:00.000Z","last4":"abcd","name":"Application Key for managing dashboards","scopes":["dashboards_read","dashboards_write","dashboards_public_share"]},"id":"string","relationships":{"owned_by":{"data":{"id":"00000000-0000-0000-2345-000000000000","type":"users"}}},"type":"application_keys"},"included":[{"attributes":{"created_at":"2019-09-19T10:00:00.000Z","disabled":false,"email":"string","handle":"string","icon":"string","modified_at":"2019-09-19T10:00:00.000Z","name":"string","service_account":false,"status":"string","title":"string","verified":false},"id":"string","relationships":{"org":{"data":{"id":"00000000-0000-beef-0000-000000000000","type":"orgs"}},"other_orgs":{"data":[{"id":"00000000-0000-beef-0000-000000000000","type":"orgs"}]},"other_users":{"data":[{"id":"00000000-0000-0000-2345-000000000000","type":"users"}]},"roles":{"data":[{"id":"3653d3c6-0c75-11ea-ad28-fb5701eabc7d","type":"roles"}]}},"type":"users"}]}
"""
Get one application key for this service account returns "OK" response
"""fromdatadog_api_clientimportApiClient,Configurationfromdatadog_api_client.v2.api.service_accounts_apiimportServiceAccountsApiconfiguration=Configuration()withApiClient(configuration)asapi_client:api_instance=ServiceAccountsApi(api_client)response=api_instance.get_service_account_application_key(service_account_id="00000000-0000-1234-0000-000000000000",app_key_id="app_key_id",)print(response)
# Get one application key for this service account returns "OK" responserequire"datadog_api_client"api_instance=DatadogAPIClient::V2::ServiceAccountsAPI.newpapi_instance.get_service_account_application_key("00000000-0000-1234-0000-000000000000","app_key_id")
// Get one application key for this service account returns "OK" response
packagemainimport("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")funcmain(){ctx:=datadog.NewDefaultContext(context.Background())configuration:=datadog.NewConfiguration()apiClient:=datadog.NewAPIClient(configuration)api:=datadogV2.NewServiceAccountsApi(apiClient)resp,r,err:=api.GetServiceAccountApplicationKey(ctx,"00000000-0000-1234-0000-000000000000","app_key_id")iferr!=nil{fmt.Fprintf(os.Stderr,"Error when calling `ServiceAccountsApi.GetServiceAccountApplicationKey`: %v\n",err)fmt.Fprintf(os.Stderr,"Full HTTP response: %v\n",r)}responseContent,_:=json.MarshalIndent(resp,""," ")fmt.Fprintf(os.Stdout,"Response from `ServiceAccountsApi.GetServiceAccountApplicationKey`:\n%s\n",responseContent)}
// Get one application key for this service account returns "OK" response
importcom.datadog.api.client.ApiClient;importcom.datadog.api.client.ApiException;importcom.datadog.api.client.v2.api.ServiceAccountsApi;importcom.datadog.api.client.v2.model.PartialApplicationKeyResponse;publicclassExample{publicstaticvoidmain(String[]args){ApiClientdefaultClient=ApiClient.getDefaultApiClient();ServiceAccountsApiapiInstance=newServiceAccountsApi(defaultClient);try{PartialApplicationKeyResponseresult=apiInstance.getServiceAccountApplicationKey("00000000-0000-1234-0000-000000000000","app_key_id");System.out.println(result);}catch(ApiExceptione){System.err.println("Exception when calling ServiceAccountsApi#getServiceAccountApplicationKey");System.err.println("Status code: "+e.getCode());System.err.println("Reason: "+e.getResponseBody());System.err.println("Response headers: "+e.getResponseHeaders());e.printStackTrace();}}}
/**
* Get one application key for this service account returns "OK" response
*/import{client,v2}from"@datadog/datadog-api-client";constconfiguration=client.createConfiguration();constapiInstance=newv2.ServiceAccountsApi(configuration);constparams: v2.ServiceAccountsApiGetServiceAccountApplicationKeyRequest={serviceAccountId:"00000000-0000-1234-0000-000000000000",appKeyId:"app_key_id",};apiInstance.getServiceAccountApplicationKey(params).then((data: v2.PartialApplicationKeyResponse)=>{console.log("API called successfully. Returned data: "+JSON.stringify(data));}).catch((error: any)=>console.error(error));
Array of scopes to grant the application key. This feature is in private beta, please contact Datadog support to enable scopes for your application keys.
{"data":{"id":"67963b57-d67c-dfa7-b180-62ee9301d2f6","type":"application_keys","attributes":{"name":"Application Key for managing dashboards-updated"}}}
Response for retrieving a partial application key.
Expand All
フィールド
種類
説明
data
object
Partial Datadog application key.
attributes
object
Attributes of a partial application key.
created_at
string
Creation date of the application key.
last4
string
The last four characters of the application key.
name
string
Name of the application key.
scopes
[string]
Array of scopes to grant the application key. This feature is in private beta, please contact Datadog support to enable scopes for your application keys.
{"data":{"attributes":{"created_at":"2020-11-23T10:00:00.000Z","last4":"abcd","name":"Application Key for managing dashboards","scopes":["dashboards_read","dashboards_write","dashboards_public_share"]},"id":"string","relationships":{"owned_by":{"data":{"id":"00000000-0000-0000-2345-000000000000","type":"users"}}},"type":"application_keys"},"included":[{"attributes":{"created_at":"2019-09-19T10:00:00.000Z","disabled":false,"email":"string","handle":"string","icon":"string","modified_at":"2019-09-19T10:00:00.000Z","name":"string","service_account":false,"status":"string","title":"string","verified":false},"id":"string","relationships":{"org":{"data":{"id":"00000000-0000-beef-0000-000000000000","type":"orgs"}},"other_orgs":{"data":[{"id":"00000000-0000-beef-0000-000000000000","type":"orgs"}]},"other_users":{"data":[{"id":"00000000-0000-0000-2345-000000000000","type":"users"}]},"roles":{"data":[{"id":"3653d3c6-0c75-11ea-ad28-fb5701eabc7d","type":"roles"}]}},"type":"users"}]}
// Edit an app key owned by this service account returns "OK" response
packagemainimport("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")funcmain(){// there is a valid "service_account_user" in the system
ServiceAccountUserDataID:=os.Getenv("SERVICE_ACCOUNT_USER_DATA_ID")// there is a valid "service_account_application_key" for "service_account_user"
ServiceAccountApplicationKeyDataID:=os.Getenv("SERVICE_ACCOUNT_APPLICATION_KEY_DATA_ID")body:=datadogV2.ApplicationKeyUpdateRequest{Data:datadogV2.ApplicationKeyUpdateData{Id:ServiceAccountApplicationKeyDataID,Type:datadogV2.APPLICATIONKEYSTYPE_APPLICATION_KEYS,Attributes:datadogV2.ApplicationKeyUpdateAttributes{Name:datadog.PtrString("Application Key for managing dashboards-updated"),},},}ctx:=datadog.NewDefaultContext(context.Background())configuration:=datadog.NewConfiguration()apiClient:=datadog.NewAPIClient(configuration)api:=datadogV2.NewServiceAccountsApi(apiClient)resp,r,err:=api.UpdateServiceAccountApplicationKey(ctx,ServiceAccountUserDataID,ServiceAccountApplicationKeyDataID,body)iferr!=nil{fmt.Fprintf(os.Stderr,"Error when calling `ServiceAccountsApi.UpdateServiceAccountApplicationKey`: %v\n",err)fmt.Fprintf(os.Stderr,"Full HTTP response: %v\n",r)}responseContent,_:=json.MarshalIndent(resp,""," ")fmt.Fprintf(os.Stdout,"Response from `ServiceAccountsApi.UpdateServiceAccountApplicationKey`:\n%s\n",responseContent)}
// Edit an app key owned by this service account returns "OK" response
importcom.datadog.api.client.ApiClient;importcom.datadog.api.client.ApiException;importcom.datadog.api.client.v2.api.ServiceAccountsApi;importcom.datadog.api.client.v2.model.ApplicationKeyUpdateAttributes;importcom.datadog.api.client.v2.model.ApplicationKeyUpdateData;importcom.datadog.api.client.v2.model.ApplicationKeyUpdateRequest;importcom.datadog.api.client.v2.model.ApplicationKeysType;importcom.datadog.api.client.v2.model.PartialApplicationKeyResponse;publicclassExample{publicstaticvoidmain(String[]args){ApiClientdefaultClient=ApiClient.getDefaultApiClient();ServiceAccountsApiapiInstance=newServiceAccountsApi(defaultClient);// there is a valid "service_account_user" in the system
StringSERVICE_ACCOUNT_USER_DATA_ID=System.getenv("SERVICE_ACCOUNT_USER_DATA_ID");// there is a valid "service_account_application_key" for "service_account_user"
StringSERVICE_ACCOUNT_APPLICATION_KEY_DATA_ATTRIBUTES_NAME=System.getenv("SERVICE_ACCOUNT_APPLICATION_KEY_DATA_ATTRIBUTES_NAME");StringSERVICE_ACCOUNT_APPLICATION_KEY_DATA_ID=System.getenv("SERVICE_ACCOUNT_APPLICATION_KEY_DATA_ID");ApplicationKeyUpdateRequestbody=newApplicationKeyUpdateRequest().data(newApplicationKeyUpdateData().id(SERVICE_ACCOUNT_APPLICATION_KEY_DATA_ID).type(ApplicationKeysType.APPLICATION_KEYS).attributes(newApplicationKeyUpdateAttributes().name("Application Key for managing dashboards-updated")));try{PartialApplicationKeyResponseresult=apiInstance.updateServiceAccountApplicationKey(SERVICE_ACCOUNT_USER_DATA_ID,SERVICE_ACCOUNT_APPLICATION_KEY_DATA_ID,body);System.out.println(result);}catch(ApiExceptione){System.err.println("Exception when calling ServiceAccountsApi#updateServiceAccountApplicationKey");System.err.println("Status code: "+e.getCode());System.err.println("Reason: "+e.getResponseBody());System.err.println("Response headers: "+e.getResponseHeaders());e.printStackTrace();}}}
"""
Edit an app key owned by this service account returns "OK" response
"""fromosimportenvironfromdatadog_api_clientimportApiClient,Configurationfromdatadog_api_client.v2.api.service_accounts_apiimportServiceAccountsApifromdatadog_api_client.v2.model.application_key_update_attributesimportApplicationKeyUpdateAttributesfromdatadog_api_client.v2.model.application_key_update_dataimportApplicationKeyUpdateDatafromdatadog_api_client.v2.model.application_key_update_requestimportApplicationKeyUpdateRequestfromdatadog_api_client.v2.model.application_keys_typeimportApplicationKeysType# there is a valid "service_account_user" in the systemSERVICE_ACCOUNT_USER_DATA_ID=environ["SERVICE_ACCOUNT_USER_DATA_ID"]# there is a valid "service_account_application_key" for "service_account_user"SERVICE_ACCOUNT_APPLICATION_KEY_DATA_ATTRIBUTES_NAME=environ["SERVICE_ACCOUNT_APPLICATION_KEY_DATA_ATTRIBUTES_NAME"]SERVICE_ACCOUNT_APPLICATION_KEY_DATA_ID=environ["SERVICE_ACCOUNT_APPLICATION_KEY_DATA_ID"]body=ApplicationKeyUpdateRequest(data=ApplicationKeyUpdateData(id=SERVICE_ACCOUNT_APPLICATION_KEY_DATA_ID,type=ApplicationKeysType.APPLICATION_KEYS,attributes=ApplicationKeyUpdateAttributes(name="Application Key for managing dashboards-updated",),),)configuration=Configuration()withApiClient(configuration)asapi_client:api_instance=ServiceAccountsApi(api_client)response=api_instance.update_service_account_application_key(service_account_id=SERVICE_ACCOUNT_USER_DATA_ID,app_key_id=SERVICE_ACCOUNT_APPLICATION_KEY_DATA_ID,body=body)print(response)
# Edit an app key owned by this service account returns "OK" responserequire"datadog_api_client"api_instance=DatadogAPIClient::V2::ServiceAccountsAPI.new# there is a valid "service_account_user" in the systemSERVICE_ACCOUNT_USER_DATA_ID=ENV["SERVICE_ACCOUNT_USER_DATA_ID"]# there is a valid "service_account_application_key" for "service_account_user"SERVICE_ACCOUNT_APPLICATION_KEY_DATA_ATTRIBUTES_NAME=ENV["SERVICE_ACCOUNT_APPLICATION_KEY_DATA_ATTRIBUTES_NAME"]SERVICE_ACCOUNT_APPLICATION_KEY_DATA_ID=ENV["SERVICE_ACCOUNT_APPLICATION_KEY_DATA_ID"]body=DatadogAPIClient::V2::ApplicationKeyUpdateRequest.new({data:DatadogAPIClient::V2::ApplicationKeyUpdateData.new({id:SERVICE_ACCOUNT_APPLICATION_KEY_DATA_ID,type:DatadogAPIClient::V2::ApplicationKeysType::APPLICATION_KEYS,attributes:DatadogAPIClient::V2::ApplicationKeyUpdateAttributes.new({name:"Application Key for managing dashboards-updated",}),}),})papi_instance.update_service_account_application_key(SERVICE_ACCOUNT_USER_DATA_ID,SERVICE_ACCOUNT_APPLICATION_KEY_DATA_ID,body)
/**
* Edit an app key owned by this service account returns "OK" response
*/import{client,v2}from"@datadog/datadog-api-client";constconfiguration=client.createConfiguration();constapiInstance=newv2.ServiceAccountsApi(configuration);// there is a valid "service_account_user" in the system
constSERVICE_ACCOUNT_USER_DATA_ID=process.env.SERVICE_ACCOUNT_USER_DATA_IDasstring;// there is a valid "service_account_application_key" for "service_account_user"
constSERVICE_ACCOUNT_APPLICATION_KEY_DATA_ID=process.env.SERVICE_ACCOUNT_APPLICATION_KEY_DATA_IDasstring;constparams: v2.ServiceAccountsApiUpdateServiceAccountApplicationKeyRequest={body:{data:{id: SERVICE_ACCOUNT_APPLICATION_KEY_DATA_ID,type:"application_keys",attributes:{name:"Application Key for managing dashboards-updated",},},},serviceAccountId: SERVICE_ACCOUNT_USER_DATA_ID,appKeyId: SERVICE_ACCOUNT_APPLICATION_KEY_DATA_ID,};apiInstance.updateServiceAccountApplicationKey(params).then((data: v2.PartialApplicationKeyResponse)=>{console.log("API called successfully. Returned data: "+JSON.stringify(data));}).catch((error: any)=>console.error(error));
"""
Delete an application key for this service account returns "No Content" response
"""fromdatadog_api_clientimportApiClient,Configurationfromdatadog_api_client.v2.api.service_accounts_apiimportServiceAccountsApiconfiguration=Configuration()withApiClient(configuration)asapi_client:api_instance=ServiceAccountsApi(api_client)api_instance.delete_service_account_application_key(service_account_id="00000000-0000-1234-0000-000000000000",app_key_id="app_key_id",)
# Delete an application key for this service account returns "No Content" responserequire"datadog_api_client"api_instance=DatadogAPIClient::V2::ServiceAccountsAPI.newapi_instance.delete_service_account_application_key("00000000-0000-1234-0000-000000000000","app_key_id")
// Delete an application key for this service account returns "No Content" response
packagemainimport("context""fmt""os""github.com/DataDog/datadog-api-client-go/v2/api/datadog""github.com/DataDog/datadog-api-client-go/v2/api/datadogV2")funcmain(){ctx:=datadog.NewDefaultContext(context.Background())configuration:=datadog.NewConfiguration()apiClient:=datadog.NewAPIClient(configuration)api:=datadogV2.NewServiceAccountsApi(apiClient)r,err:=api.DeleteServiceAccountApplicationKey(ctx,"00000000-0000-1234-0000-000000000000","app_key_id")iferr!=nil{fmt.Fprintf(os.Stderr,"Error when calling `ServiceAccountsApi.DeleteServiceAccountApplicationKey`: %v\n",err)fmt.Fprintf(os.Stderr,"Full HTTP response: %v\n",r)}}
// Delete an application key for this service account returns "No Content" response
importcom.datadog.api.client.ApiClient;importcom.datadog.api.client.ApiException;importcom.datadog.api.client.v2.api.ServiceAccountsApi;publicclassExample{publicstaticvoidmain(String[]args){ApiClientdefaultClient=ApiClient.getDefaultApiClient();ServiceAccountsApiapiInstance=newServiceAccountsApi(defaultClient);try{apiInstance.deleteServiceAccountApplicationKey("00000000-0000-1234-0000-000000000000","app_key_id");}catch(ApiExceptione){System.err.println("Exception when calling ServiceAccountsApi#deleteServiceAccountApplicationKey");System.err.println("Status code: "+e.getCode());System.err.println("Reason: "+e.getResponseBody());System.err.println("Response headers: "+e.getResponseHeaders());e.printStackTrace();}}}
/**
* Delete an application key for this service account returns "No Content" response
*/import{client,v2}from"@datadog/datadog-api-client";constconfiguration=client.createConfiguration();constapiInstance=newv2.ServiceAccountsApi(configuration);constparams: v2.ServiceAccountsApiDeleteServiceAccountApplicationKeyRequest={serviceAccountId:"00000000-0000-1234-0000-000000000000",appKeyId:"app_key_id",};apiInstance.deleteServiceAccountApplicationKey(params).then((data: any)=>{console.log("API called successfully. Returned data: "+JSON.stringify(data));}).catch((error: any)=>console.error(error));
Array of scopes to grant the application key. This feature is in private beta, please contact Datadog support to enable scopes for your application keys.
Array of scopes to grant the application key. This feature is in private beta, please contact Datadog support to enable scopes for your application keys.
{"data":{"attributes":{"created_at":"2020-11-23T10:00:00.000Z","key":"string","last4":"abcd","name":"Application Key for managing dashboards","scopes":["dashboards_read","dashboards_write","dashboards_public_share"]},"id":"string","relationships":{"owned_by":{"data":{"id":"00000000-0000-0000-2345-000000000000","type":"users"}}},"type":"application_keys"},"included":[{"attributes":{"created_at":"2019-09-19T10:00:00.000Z","disabled":false,"email":"string","handle":"string","icon":"string","modified_at":"2019-09-19T10:00:00.000Z","name":"string","service_account":false,"status":"string","title":"string","verified":false},"id":"string","relationships":{"org":{"data":{"id":"00000000-0000-beef-0000-000000000000","type":"orgs"}},"other_orgs":{"data":[{"id":"00000000-0000-beef-0000-000000000000","type":"orgs"}]},"other_users":{"data":[{"id":"00000000-0000-0000-2345-000000000000","type":"users"}]},"roles":{"data":[{"id":"3653d3c6-0c75-11ea-ad28-fb5701eabc7d","type":"roles"}]}},"type":"users"}]}
// Create an app key for this service account returns "Created" response
packagemainimport("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")funcmain(){// there is a valid "service_account_user" in the system
ServiceAccountUserDataID:=os.Getenv("SERVICE_ACCOUNT_USER_DATA_ID")body:=datadogV2.ApplicationKeyCreateRequest{Data:datadogV2.ApplicationKeyCreateData{Attributes:datadogV2.ApplicationKeyCreateAttributes{Name:"Example-Service-Account",},Type:datadogV2.APPLICATIONKEYSTYPE_APPLICATION_KEYS,},}ctx:=datadog.NewDefaultContext(context.Background())configuration:=datadog.NewConfiguration()apiClient:=datadog.NewAPIClient(configuration)api:=datadogV2.NewServiceAccountsApi(apiClient)resp,r,err:=api.CreateServiceAccountApplicationKey(ctx,ServiceAccountUserDataID,body)iferr!=nil{fmt.Fprintf(os.Stderr,"Error when calling `ServiceAccountsApi.CreateServiceAccountApplicationKey`: %v\n",err)fmt.Fprintf(os.Stderr,"Full HTTP response: %v\n",r)}responseContent,_:=json.MarshalIndent(resp,""," ")fmt.Fprintf(os.Stdout,"Response from `ServiceAccountsApi.CreateServiceAccountApplicationKey`:\n%s\n",responseContent)}
// Create an application key with scopes for this service account returns "Created" response
packagemainimport("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")funcmain(){// there is a valid "service_account_user" in the system
ServiceAccountUserDataID:=os.Getenv("SERVICE_ACCOUNT_USER_DATA_ID")body:=datadogV2.ApplicationKeyCreateRequest{Data:datadogV2.ApplicationKeyCreateData{Attributes:datadogV2.ApplicationKeyCreateAttributes{Name:"Example-Service-Account",Scopes:[]string{"dashboards_read","dashboards_write","dashboards_public_share",},},Type:datadogV2.APPLICATIONKEYSTYPE_APPLICATION_KEYS,},}ctx:=datadog.NewDefaultContext(context.Background())configuration:=datadog.NewConfiguration()apiClient:=datadog.NewAPIClient(configuration)api:=datadogV2.NewServiceAccountsApi(apiClient)resp,r,err:=api.CreateServiceAccountApplicationKey(ctx,ServiceAccountUserDataID,body)iferr!=nil{fmt.Fprintf(os.Stderr,"Error when calling `ServiceAccountsApi.CreateServiceAccountApplicationKey`: %v\n",err)fmt.Fprintf(os.Stderr,"Full HTTP response: %v\n",r)}responseContent,_:=json.MarshalIndent(resp,""," ")fmt.Fprintf(os.Stdout,"Response from `ServiceAccountsApi.CreateServiceAccountApplicationKey`:\n%s\n",responseContent)}
// Create an app key for this service account returns "Created" response
importcom.datadog.api.client.ApiClient;importcom.datadog.api.client.ApiException;importcom.datadog.api.client.v2.api.ServiceAccountsApi;importcom.datadog.api.client.v2.model.ApplicationKeyCreateAttributes;importcom.datadog.api.client.v2.model.ApplicationKeyCreateData;importcom.datadog.api.client.v2.model.ApplicationKeyCreateRequest;importcom.datadog.api.client.v2.model.ApplicationKeyResponse;importcom.datadog.api.client.v2.model.ApplicationKeysType;publicclassExample{publicstaticvoidmain(String[]args){ApiClientdefaultClient=ApiClient.getDefaultApiClient();ServiceAccountsApiapiInstance=newServiceAccountsApi(defaultClient);// there is a valid "service_account_user" in the system
StringSERVICE_ACCOUNT_USER_DATA_ID=System.getenv("SERVICE_ACCOUNT_USER_DATA_ID");ApplicationKeyCreateRequestbody=newApplicationKeyCreateRequest().data(newApplicationKeyCreateData().attributes(newApplicationKeyCreateAttributes().name("Example-Service-Account")).type(ApplicationKeysType.APPLICATION_KEYS));try{ApplicationKeyResponseresult=apiInstance.createServiceAccountApplicationKey(SERVICE_ACCOUNT_USER_DATA_ID,body);System.out.println(result);}catch(ApiExceptione){System.err.println("Exception when calling ServiceAccountsApi#createServiceAccountApplicationKey");System.err.println("Status code: "+e.getCode());System.err.println("Reason: "+e.getResponseBody());System.err.println("Response headers: "+e.getResponseHeaders());e.printStackTrace();}}}
// Create an application key with scopes for this service account returns "Created" response
importcom.datadog.api.client.ApiClient;importcom.datadog.api.client.ApiException;importcom.datadog.api.client.v2.api.ServiceAccountsApi;importcom.datadog.api.client.v2.model.ApplicationKeyCreateAttributes;importcom.datadog.api.client.v2.model.ApplicationKeyCreateData;importcom.datadog.api.client.v2.model.ApplicationKeyCreateRequest;importcom.datadog.api.client.v2.model.ApplicationKeyResponse;importcom.datadog.api.client.v2.model.ApplicationKeysType;importjava.util.Arrays;publicclassExample{publicstaticvoidmain(String[]args){ApiClientdefaultClient=ApiClient.getDefaultApiClient();ServiceAccountsApiapiInstance=newServiceAccountsApi(defaultClient);// there is a valid "service_account_user" in the system
StringSERVICE_ACCOUNT_USER_DATA_ID=System.getenv("SERVICE_ACCOUNT_USER_DATA_ID");ApplicationKeyCreateRequestbody=newApplicationKeyCreateRequest().data(newApplicationKeyCreateData().attributes(newApplicationKeyCreateAttributes().name("Example-Service-Account").scopes(Arrays.asList("dashboards_read","dashboards_write","dashboards_public_share"))).type(ApplicationKeysType.APPLICATION_KEYS));try{ApplicationKeyResponseresult=apiInstance.createServiceAccountApplicationKey(SERVICE_ACCOUNT_USER_DATA_ID,body);System.out.println(result);}catch(ApiExceptione){System.err.println("Exception when calling ServiceAccountsApi#createServiceAccountApplicationKey");System.err.println("Status code: "+e.getCode());System.err.println("Reason: "+e.getResponseBody());System.err.println("Response headers: "+e.getResponseHeaders());e.printStackTrace();}}}
"""
Create an app key for this service account returns "Created" response
"""fromosimportenvironfromdatadog_api_clientimportApiClient,Configurationfromdatadog_api_client.v2.api.service_accounts_apiimportServiceAccountsApifromdatadog_api_client.v2.model.application_key_create_attributesimportApplicationKeyCreateAttributesfromdatadog_api_client.v2.model.application_key_create_dataimportApplicationKeyCreateDatafromdatadog_api_client.v2.model.application_key_create_requestimportApplicationKeyCreateRequestfromdatadog_api_client.v2.model.application_keys_typeimportApplicationKeysType# there is a valid "service_account_user" in the systemSERVICE_ACCOUNT_USER_DATA_ID=environ["SERVICE_ACCOUNT_USER_DATA_ID"]body=ApplicationKeyCreateRequest(data=ApplicationKeyCreateData(attributes=ApplicationKeyCreateAttributes(name="Example-Service-Account",),type=ApplicationKeysType.APPLICATION_KEYS,),)configuration=Configuration()withApiClient(configuration)asapi_client:api_instance=ServiceAccountsApi(api_client)response=api_instance.create_service_account_application_key(service_account_id=SERVICE_ACCOUNT_USER_DATA_ID,body=body)print(response)
"""
Create an application key with scopes for this service account returns "Created" response
"""fromosimportenvironfromdatadog_api_clientimportApiClient,Configurationfromdatadog_api_client.v2.api.service_accounts_apiimportServiceAccountsApifromdatadog_api_client.v2.model.application_key_create_attributesimportApplicationKeyCreateAttributesfromdatadog_api_client.v2.model.application_key_create_dataimportApplicationKeyCreateDatafromdatadog_api_client.v2.model.application_key_create_requestimportApplicationKeyCreateRequestfromdatadog_api_client.v2.model.application_keys_typeimportApplicationKeysType# there is a valid "service_account_user" in the systemSERVICE_ACCOUNT_USER_DATA_ID=environ["SERVICE_ACCOUNT_USER_DATA_ID"]body=ApplicationKeyCreateRequest(data=ApplicationKeyCreateData(attributes=ApplicationKeyCreateAttributes(name="Example-Service-Account",scopes=["dashboards_read","dashboards_write","dashboards_public_share",],),type=ApplicationKeysType.APPLICATION_KEYS,),)configuration=Configuration()withApiClient(configuration)asapi_client:api_instance=ServiceAccountsApi(api_client)response=api_instance.create_service_account_application_key(service_account_id=SERVICE_ACCOUNT_USER_DATA_ID,body=body)print(response)
# Create an app key for this service account returns "Created" responserequire"datadog_api_client"api_instance=DatadogAPIClient::V2::ServiceAccountsAPI.new# there is a valid "service_account_user" in the systemSERVICE_ACCOUNT_USER_DATA_ID=ENV["SERVICE_ACCOUNT_USER_DATA_ID"]body=DatadogAPIClient::V2::ApplicationKeyCreateRequest.new({data:DatadogAPIClient::V2::ApplicationKeyCreateData.new({attributes:DatadogAPIClient::V2::ApplicationKeyCreateAttributes.new({name:"Example-Service-Account",}),type:DatadogAPIClient::V2::ApplicationKeysType::APPLICATION_KEYS,}),})papi_instance.create_service_account_application_key(SERVICE_ACCOUNT_USER_DATA_ID,body)
# Create an application key with scopes for this service account returns "Created" responserequire"datadog_api_client"api_instance=DatadogAPIClient::V2::ServiceAccountsAPI.new# there is a valid "service_account_user" in the systemSERVICE_ACCOUNT_USER_DATA_ID=ENV["SERVICE_ACCOUNT_USER_DATA_ID"]body=DatadogAPIClient::V2::ApplicationKeyCreateRequest.new({data:DatadogAPIClient::V2::ApplicationKeyCreateData.new({attributes:DatadogAPIClient::V2::ApplicationKeyCreateAttributes.new({name:"Example-Service-Account",scopes:["dashboards_read","dashboards_write","dashboards_public_share",],}),type:DatadogAPIClient::V2::ApplicationKeysType::APPLICATION_KEYS,}),})papi_instance.create_service_account_application_key(SERVICE_ACCOUNT_USER_DATA_ID,body)
/**
* Create an app key for this service account returns "Created" response
*/import{client,v2}from"@datadog/datadog-api-client";constconfiguration=client.createConfiguration();constapiInstance=newv2.ServiceAccountsApi(configuration);// there is a valid "service_account_user" in the system
constSERVICE_ACCOUNT_USER_DATA_ID=process.env.SERVICE_ACCOUNT_USER_DATA_IDasstring;constparams: v2.ServiceAccountsApiCreateServiceAccountApplicationKeyRequest={body:{data:{attributes:{name:"Example-Service-Account",},type:"application_keys",},},serviceAccountId: SERVICE_ACCOUNT_USER_DATA_ID,};apiInstance.createServiceAccountApplicationKey(params).then((data: v2.ApplicationKeyResponse)=>{console.log("API called successfully. Returned data: "+JSON.stringify(data));}).catch((error: any)=>console.error(error));
/**
* Create an application key with scopes for this service account returns "Created" response
*/import{client,v2}from"@datadog/datadog-api-client";constconfiguration=client.createConfiguration();constapiInstance=newv2.ServiceAccountsApi(configuration);// there is a valid "service_account_user" in the system
constSERVICE_ACCOUNT_USER_DATA_ID=process.env.SERVICE_ACCOUNT_USER_DATA_IDasstring;constparams: v2.ServiceAccountsApiCreateServiceAccountApplicationKeyRequest={body:{data:{attributes:{name:"Example-Service-Account",scopes:["dashboards_read","dashboards_write","dashboards_public_share",],},type:"application_keys",},},serviceAccountId: SERVICE_ACCOUNT_USER_DATA_ID,};apiInstance.createServiceAccountApplicationKey(params).then((data: v2.ApplicationKeyResponse)=>{console.log("API called successfully. Returned data: "+JSON.stringify(data));}).catch((error: any)=>console.error(error));
List all application keys available for this service account.
引数
パスパラメーター
名前
種類
説明
service_account_id [required]
string
The ID of the service account.
クエリ文字列
名前
種類
説明
page[size]
integer
Size for a given page. The maximum allowed value is 5000.
page[number]
integer
Specific page number to return.
sort
enum
Application key attribute used to sort results. Sort order is ascending
by default. In order to specify a descending sort, prefix the
attribute with a minus sign. Allowed enum values: created_at, -created_at, last4, -last4, name, -name
filter
string
Filter application keys by the specified string.
filter[created_at][start]
string
Only include application keys created on or after the specified date.
filter[created_at][end]
string
Only include application keys created on or before the specified date.
Array of scopes to grant the application key. This feature is in private beta, please contact Datadog support to enable scopes for your application keys.
{"data":[{"attributes":{"created_at":"2020-11-23T10:00:00.000Z","last4":"abcd","name":"Application Key for managing dashboards","scopes":["dashboards_read","dashboards_write","dashboards_public_share"]},"id":"string","relationships":{"owned_by":{"data":{"id":"00000000-0000-0000-2345-000000000000","type":"users"}}},"type":"application_keys"}],"included":[{"attributes":{"created_at":"2019-09-19T10:00:00.000Z","disabled":false,"email":"string","handle":"string","icon":"string","modified_at":"2019-09-19T10:00:00.000Z","name":"string","service_account":false,"status":"string","title":"string","verified":false},"id":"string","relationships":{"org":{"data":{"id":"00000000-0000-beef-0000-000000000000","type":"orgs"}},"other_orgs":{"data":[{"id":"00000000-0000-beef-0000-000000000000","type":"orgs"}]},"other_users":{"data":[{"id":"00000000-0000-0000-2345-000000000000","type":"users"}]},"roles":{"data":[{"id":"3653d3c6-0c75-11ea-ad28-fb5701eabc7d","type":"roles"}]}},"type":"users"}]}
"""
List application keys for this service account returns "OK" response
"""fromdatadog_api_clientimportApiClient,Configurationfromdatadog_api_client.v2.api.service_accounts_apiimportServiceAccountsApiconfiguration=Configuration()withApiClient(configuration)asapi_client:api_instance=ServiceAccountsApi(api_client)response=api_instance.list_service_account_application_keys(service_account_id="00000000-0000-1234-0000-000000000000",)print(response)
# List application keys for this service account returns "OK" responserequire"datadog_api_client"api_instance=DatadogAPIClient::V2::ServiceAccountsAPI.newpapi_instance.list_service_account_application_keys("00000000-0000-1234-0000-000000000000")
// List application keys for this service account returns "OK" response
packagemainimport("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")funcmain(){ctx:=datadog.NewDefaultContext(context.Background())configuration:=datadog.NewConfiguration()apiClient:=datadog.NewAPIClient(configuration)api:=datadogV2.NewServiceAccountsApi(apiClient)resp,r,err:=api.ListServiceAccountApplicationKeys(ctx,"00000000-0000-1234-0000-000000000000",*datadogV2.NewListServiceAccountApplicationKeysOptionalParameters())iferr!=nil{fmt.Fprintf(os.Stderr,"Error when calling `ServiceAccountsApi.ListServiceAccountApplicationKeys`: %v\n",err)fmt.Fprintf(os.Stderr,"Full HTTP response: %v\n",r)}responseContent,_:=json.MarshalIndent(resp,""," ")fmt.Fprintf(os.Stdout,"Response from `ServiceAccountsApi.ListServiceAccountApplicationKeys`:\n%s\n",responseContent)}
// List application keys for this service account returns "OK" response
importcom.datadog.api.client.ApiClient;importcom.datadog.api.client.ApiException;importcom.datadog.api.client.v2.api.ServiceAccountsApi;importcom.datadog.api.client.v2.model.ListApplicationKeysResponse;publicclassExample{publicstaticvoidmain(String[]args){ApiClientdefaultClient=ApiClient.getDefaultApiClient();ServiceAccountsApiapiInstance=newServiceAccountsApi(defaultClient);try{ListApplicationKeysResponseresult=apiInstance.listServiceAccountApplicationKeys("00000000-0000-1234-0000-000000000000");System.out.println(result);}catch(ApiExceptione){System.err.println("Exception when calling ServiceAccountsApi#listServiceAccountApplicationKeys");System.err.println("Status code: "+e.getCode());System.err.println("Reason: "+e.getResponseBody());System.err.println("Response headers: "+e.getResponseHeaders());e.printStackTrace();}}}
/**
* List application keys for this service account returns "OK" response
*/import{client,v2}from"@datadog/datadog-api-client";constconfiguration=client.createConfiguration();constapiInstance=newv2.ServiceAccountsApi(configuration);constparams: v2.ServiceAccountsApiListServiceAccountApplicationKeysRequest={serviceAccountId:"00000000-0000-1234-0000-000000000000",};apiInstance.listServiceAccountApplicationKeys(params).then((data: v2.ListApplicationKeysResponse)=>{console.log("API called successfully. Returned data: "+JSON.stringify(data));}).catch((error: any)=>console.error(error));