The name of the role. The name is neither unique nor a stable identifier of the role.
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.
user_count
int64
Number of users with that role.
id
string
The unique identifier of the role.
relationships
object
Relationships of the role object returned by the API.
// Update a user returns "OK" responsepackagemainimport("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 "user" in the systemUserDataID:=os.Getenv("USER_DATA_ID")body:=datadogV2.UserUpdateRequest{Data:datadogV2.UserUpdateData{Id:UserDataID,Type:datadogV2.USERSTYPE_USERS,Attributes:datadogV2.UserUpdateAttributes{Name:datadog.PtrString("updated"),Disabled:datadog.PtrBool(true),},},}ctx:=datadog.NewDefaultContext(context.Background())configuration:=datadog.NewConfiguration()apiClient:=datadog.NewAPIClient(configuration)api:=datadogV2.NewUsersApi(apiClient)resp,r,err:=api.UpdateUser(ctx,UserDataID,body)iferr!=nil{fmt.Fprintf(os.Stderr,"Error when calling `UsersApi.UpdateUser`: %v\n",err)fmt.Fprintf(os.Stderr,"Full HTTP response: %v\n",r)}responseContent,_:=json.MarshalIndent(resp,""," ")fmt.Fprintf(os.Stdout,"Response from `UsersApi.UpdateUser`:\n%s\n",responseContent)}
// Update a user returns "OK" responseimportcom.datadog.api.client.ApiClient;importcom.datadog.api.client.ApiException;importcom.datadog.api.client.v2.api.UsersApi;importcom.datadog.api.client.v2.model.UserResponse;importcom.datadog.api.client.v2.model.UserUpdateAttributes;importcom.datadog.api.client.v2.model.UserUpdateData;importcom.datadog.api.client.v2.model.UserUpdateRequest;importcom.datadog.api.client.v2.model.UsersType;publicclassExample{publicstaticvoidmain(String[]args){ApiClientdefaultClient=ApiClient.getDefaultApiClient();UsersApiapiInstance=newUsersApi(defaultClient);// there is a valid "user" in the systemStringUSER_DATA_ID=System.getenv("USER_DATA_ID");UserUpdateRequestbody=newUserUpdateRequest().data(newUserUpdateData().id(USER_DATA_ID).type(UsersType.USERS).attributes(newUserUpdateAttributes().name("updated").disabled(true)));try{UserResponseresult=apiInstance.updateUser(USER_DATA_ID,body);System.out.println(result);}catch(ApiExceptione){System.err.println("Exception when calling UsersApi#updateUser");System.err.println("Status code: "+e.getCode());System.err.println("Reason: "+e.getResponseBody());System.err.println("Response headers: "+e.getResponseHeaders());e.printStackTrace();}}}
"""
Update a user returns "OK" response
"""fromosimportenvironfromdatadog_api_clientimportApiClient,Configurationfromdatadog_api_client.v2.api.users_apiimportUsersApifromdatadog_api_client.v2.model.user_update_attributesimportUserUpdateAttributesfromdatadog_api_client.v2.model.user_update_dataimportUserUpdateDatafromdatadog_api_client.v2.model.user_update_requestimportUserUpdateRequestfromdatadog_api_client.v2.model.users_typeimportUsersType# there is a valid "user" in the systemUSER_DATA_ID=environ["USER_DATA_ID"]body=UserUpdateRequest(data=UserUpdateData(id=USER_DATA_ID,type=UsersType.USERS,attributes=UserUpdateAttributes(name="updated",disabled=True,),),)configuration=Configuration()withApiClient(configuration)asapi_client:api_instance=UsersApi(api_client)response=api_instance.update_user(user_id=USER_DATA_ID,body=body)print(response)
# Update a user returns "OK" responserequire"datadog_api_client"api_instance=DatadogAPIClient::V2::UsersAPI.new# there is a valid "user" in the systemUSER_DATA_ID=ENV["USER_DATA_ID"]body=DatadogAPIClient::V2::UserUpdateRequest.new({data:DatadogAPIClient::V2::UserUpdateData.new({id:USER_DATA_ID,type:DatadogAPIClient::V2::UsersType::USERS,attributes:DatadogAPIClient::V2::UserUpdateAttributes.new({name:"updated",disabled:true,}),}),})papi_instance.update_user(USER_DATA_ID,body)
// Update a user returns "OK" response
usedatadog_api_client::datadog;usedatadog_api_client::datadogV2::api_users::UsersAPI;usedatadog_api_client::datadogV2::model::UserUpdateAttributes;usedatadog_api_client::datadogV2::model::UserUpdateData;usedatadog_api_client::datadogV2::model::UserUpdateRequest;usedatadog_api_client::datadogV2::model::UsersType;#[tokio::main]asyncfnmain(){// there is a valid "user" in the system
letuser_data_id=std::env::var("USER_DATA_ID").unwrap();letbody=UserUpdateRequest::new(UserUpdateData::new(UserUpdateAttributes::new().disabled(true).name("updated".to_string()),user_data_id.clone(),UsersType::USERS,));letconfiguration=datadog::Configuration::new();letapi=UsersAPI::with_config(configuration);letresp=api.update_user(user_data_id.clone(),body).await;ifletOk(value)=resp{println!("{:#?}",value);}else{println!("{:#?}",resp.unwrap_err());}}
DD_SITE="datadoghq.comus3.datadoghq.comus5.datadoghq.comdatadoghq.euap1.datadoghq.comap2.datadoghq.comuk1.datadoghq.comddog-gov.comus2.ddog-gov.com"DD_API_KEY="<DD_API_KEY>"DD_APP_KEY="<DD_APP_KEY>"cargo run
/**
* Update a user returns "OK" response
*/import{client,v2}from"@datadog/datadog-api-client";constconfiguration=client.createConfiguration();constapiInstance=newv2.UsersApi(configuration);// there is a valid "user" in the system
constUSER_DATA_ID=process.env.USER_DATA_IDasstring;constparams: v2.UsersApiUpdateUserRequest={body:{data:{id: USER_DATA_ID,type:"users",attributes:{name:"updated",disabled: true,},},},userId: USER_DATA_ID,};apiInstance.updateUser(params).then((data: v2.UserResponse)=>{console.log("API called successfully. Returned data: "+JSON.stringify(data));}).catch((error: any)=>console.error(error));
"""
Update a user returns "User updated" response
"""fromdatadog_api_clientimportApiClient,Configurationfromdatadog_api_client.v1.api.users_apiimportUsersApifromdatadog_api_client.v1.model.access_roleimportAccessRolefromdatadog_api_client.v1.model.userimportUserbody=User(access_role=AccessRole.READ_ONLY,disabled=False,email="test@datadoghq.com",handle="test@datadoghq.com",name="test user",)configuration=Configuration()withApiClient(configuration)asapi_client:api_instance=UsersApi(api_client)response=api_instance.update_user(user_handle="test@datadoghq.com",body=body)print(response)
# Update a user returns "User updated" responserequire"datadog_api_client"api_instance=DatadogAPIClient::V1::UsersAPI.newbody=DatadogAPIClient::V1::User.new({access_role:DatadogAPIClient::V1::AccessRole::READ_ONLY,disabled:false,email:"test@datadoghq.com",handle:"test@datadoghq.com",name:"test user",})papi_instance.update_user("test@datadoghq.com",body)
// Update a user returns "User updated" responsepackagemainimport("context""encoding/json""fmt""os""github.com/DataDog/datadog-api-client-go/v2/api/datadog""github.com/DataDog/datadog-api-client-go/v2/api/datadogV1")funcmain(){body:=datadogV1.User{AccessRole:*datadogV1.NewNullableAccessRole(datadogV1.ACCESSROLE_READ_ONLY.Ptr()),Disabled:datadog.PtrBool(false),Email:datadog.PtrString("test@datadoghq.com"),Handle:datadog.PtrString("test@datadoghq.com"),Name:datadog.PtrString("test user"),}ctx:=datadog.NewDefaultContext(context.Background())configuration:=datadog.NewConfiguration()apiClient:=datadog.NewAPIClient(configuration)api:=datadogV1.NewUsersApi(apiClient)resp,r,err:=api.UpdateUser(ctx,"test@datadoghq.com",body)iferr!=nil{fmt.Fprintf(os.Stderr,"Error when calling `UsersApi.UpdateUser`: %v\n",err)fmt.Fprintf(os.Stderr,"Full HTTP response: %v\n",r)}responseContent,_:=json.MarshalIndent(resp,""," ")fmt.Fprintf(os.Stdout,"Response from `UsersApi.UpdateUser`:\n%s\n",responseContent)}
// Update a user returns "User updated" response
usedatadog_api_client::datadog;usedatadog_api_client::datadogV1::api_users::UsersAPI;usedatadog_api_client::datadogV1::model::AccessRole;usedatadog_api_client::datadogV1::model::User;#[tokio::main]asyncfnmain(){letbody=User::new().access_role(Some(AccessRole::READ_ONLY)).disabled(false).email("test@datadoghq.com".to_string()).handle("test@datadoghq.com".to_string()).name("test user".to_string());letconfiguration=datadog::Configuration::new();letapi=UsersAPI::with_config(configuration);letresp=api.update_user("test@datadoghq.com".to_string(),body).await;ifletOk(value)=resp{println!("{:#?}",value);}else{println!("{:#?}",resp.unwrap_err());}}
DD_SITE="datadoghq.comus3.datadoghq.comus5.datadoghq.comdatadoghq.euap1.datadoghq.comap2.datadoghq.comuk1.datadoghq.comddog-gov.comus2.ddog-gov.com"DD_API_KEY="<API-KEY>"DD_APP_KEY="<APP-KEY>"cargo run
/**
* Update a user returns "User updated" response
*/import{client,v1}from"@datadog/datadog-api-client";constconfiguration=client.createConfiguration();constapiInstance=newv1.UsersApi(configuration);constparams: v1.UsersApiUpdateUserRequest={body:{accessRole:"ro",disabled: false,email:"test@datadoghq.com",handle:"test@datadoghq.com",name:"test user",},userHandle:"test@datadoghq.com",};apiInstance.updateUser(params).then((data: v1.UserResponse)=>{console.log("API called successfully. Returned data: "+JSON.stringify(data));}).catch((error: any)=>console.error(error));