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.
Response containing information about an updated role.
Expand All
Field
Type
Description
data
object
Role object returned by the API.
attributes
object
Attributes of the role.
created_at
date-time
Creation time of the role.
modified_at
date-time
Time of last role modification.
name
string
Name 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
int32
The user count.
id
string
The unique identifier of the role.
relationships
object
Relationships of the role object returned by the API.
"""
Update a role returns "OK" response
"""fromosimportenvironfromdatadog_api_clientimportApiClient,Configurationfromdatadog_api_client.v2.api.roles_apiimportRolesApifromdatadog_api_client.v2.model.permissions_typeimportPermissionsTypefromdatadog_api_client.v2.model.relationship_to_permission_dataimportRelationshipToPermissionDatafromdatadog_api_client.v2.model.relationship_to_permissionsimportRelationshipToPermissionsfromdatadog_api_client.v2.model.role_relationshipsimportRoleRelationshipsfromdatadog_api_client.v2.model.role_update_attributesimportRoleUpdateAttributesfromdatadog_api_client.v2.model.role_update_dataimportRoleUpdateDatafromdatadog_api_client.v2.model.role_update_requestimportRoleUpdateRequestfromdatadog_api_client.v2.model.roles_typeimportRolesType# there is a valid "role" in the systemROLE_DATA_ATTRIBUTES_NAME=environ["ROLE_DATA_ATTRIBUTES_NAME"]ROLE_DATA_ID=environ["ROLE_DATA_ID"]# there is a valid "permission" in the systemPERMISSION_ID=environ["PERMISSION_ID"]body=RoleUpdateRequest(data=RoleUpdateData(id=ROLE_DATA_ID,type=RolesType.ROLES,attributes=RoleUpdateAttributes(name="developers-updated",),relationships=RoleRelationships(permissions=RelationshipToPermissions(data=[RelationshipToPermissionData(id=PERMISSION_ID,type=PermissionsType.PERMISSIONS,),],),),),)configuration=Configuration()withApiClient(configuration)asapi_client:api_instance=RolesApi(api_client)response=api_instance.update_role(role_id=ROLE_DATA_ID,body=body)print(response)
# Update a role returns "OK" responserequire"datadog_api_client"api_instance=DatadogAPIClient::V2::RolesAPI.new# there is a valid "role" in the systemROLE_DATA_ATTRIBUTES_NAME=ENV["ROLE_DATA_ATTRIBUTES_NAME"]ROLE_DATA_ID=ENV["ROLE_DATA_ID"]# there is a valid "permission" in the systemPERMISSION_ID=ENV["PERMISSION_ID"]body=DatadogAPIClient::V2::RoleUpdateRequest.new({data:DatadogAPIClient::V2::RoleUpdateData.new({id:ROLE_DATA_ID,type:DatadogAPIClient::V2::RolesType::ROLES,attributes:DatadogAPIClient::V2::RoleUpdateAttributes.new({name:"developers-updated",}),relationships:DatadogAPIClient::V2::RoleRelationships.new({permissions:DatadogAPIClient::V2::RelationshipToPermissions.new({data:[DatadogAPIClient::V2::RelationshipToPermissionData.new({id:PERMISSION_ID,type:DatadogAPIClient::V2::PermissionsType::PERMISSIONS,}),],}),}),}),})papi_instance.update_role(ROLE_DATA_ID,body)
// Update a role 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 "role" in the systemRoleDataID:=os.Getenv("ROLE_DATA_ID")// there is a valid "permission" in the systemPermissionID:=os.Getenv("PERMISSION_ID")body:=datadogV2.RoleUpdateRequest{Data:datadogV2.RoleUpdateData{Id:RoleDataID,Type:datadogV2.ROLESTYPE_ROLES,Attributes:datadogV2.RoleUpdateAttributes{Name:datadog.PtrString("developers-updated"),},Relationships:&datadogV2.RoleRelationships{Permissions:&datadogV2.RelationshipToPermissions{Data:[]datadogV2.RelationshipToPermissionData{{Id:datadog.PtrString(PermissionID),Type:datadogV2.PERMISSIONSTYPE_PERMISSIONS.Ptr(),},},},},},}ctx:=datadog.NewDefaultContext(context.Background())configuration:=datadog.NewConfiguration()apiClient:=datadog.NewAPIClient(configuration)api:=datadogV2.NewRolesApi(apiClient)resp,r,err:=api.UpdateRole(ctx,RoleDataID,body)iferr!=nil{fmt.Fprintf(os.Stderr,"Error when calling `RolesApi.UpdateRole`: %v\n",err)fmt.Fprintf(os.Stderr,"Full HTTP response: %v\n",r)}responseContent,_:=json.MarshalIndent(resp,""," ")fmt.Fprintf(os.Stdout,"Response from `RolesApi.UpdateRole`:\n%s\n",responseContent)}
// Update a role returns "OK" responseimportcom.datadog.api.client.ApiClient;importcom.datadog.api.client.ApiException;importcom.datadog.api.client.v2.api.RolesApi;importcom.datadog.api.client.v2.model.PermissionsType;importcom.datadog.api.client.v2.model.RelationshipToPermissionData;importcom.datadog.api.client.v2.model.RelationshipToPermissions;importcom.datadog.api.client.v2.model.RoleRelationships;importcom.datadog.api.client.v2.model.RoleUpdateAttributes;importcom.datadog.api.client.v2.model.RoleUpdateData;importcom.datadog.api.client.v2.model.RoleUpdateRequest;importcom.datadog.api.client.v2.model.RoleUpdateResponse;importcom.datadog.api.client.v2.model.RolesType;importjava.util.Collections;publicclassExample{publicstaticvoidmain(String[]args){ApiClientdefaultClient=ApiClient.getDefaultApiClient();RolesApiapiInstance=newRolesApi(defaultClient);// there is a valid "role" in the systemStringROLE_DATA_ATTRIBUTES_NAME=System.getenv("ROLE_DATA_ATTRIBUTES_NAME");StringROLE_DATA_ID=System.getenv("ROLE_DATA_ID");// there is a valid "permission" in the systemStringPERMISSION_ID=System.getenv("PERMISSION_ID");RoleUpdateRequestbody=newRoleUpdateRequest().data(newRoleUpdateData().id(ROLE_DATA_ID).type(RolesType.ROLES).attributes(newRoleUpdateAttributes().name("developers-updated")).relationships(newRoleRelationships().permissions(newRelationshipToPermissions().data(Collections.singletonList(newRelationshipToPermissionData().id(PERMISSION_ID).type(PermissionsType.PERMISSIONS))))));try{RoleUpdateResponseresult=apiInstance.updateRole(ROLE_DATA_ID,body);System.out.println(result);}catch(ApiExceptione){System.err.println("Exception when calling RolesApi#updateRole");System.err.println("Status code: "+e.getCode());System.err.println("Reason: "+e.getResponseBody());System.err.println("Response headers: "+e.getResponseHeaders());e.printStackTrace();}}}
// Update a role returns "OK" response
usedatadog_api_client::datadog;usedatadog_api_client::datadogV2::api_roles::RolesAPI;usedatadog_api_client::datadogV2::model::PermissionsType;usedatadog_api_client::datadogV2::model::RelationshipToPermissionData;usedatadog_api_client::datadogV2::model::RelationshipToPermissions;usedatadog_api_client::datadogV2::model::RoleRelationships;usedatadog_api_client::datadogV2::model::RoleUpdateAttributes;usedatadog_api_client::datadogV2::model::RoleUpdateData;usedatadog_api_client::datadogV2::model::RoleUpdateRequest;usedatadog_api_client::datadogV2::model::RolesType;#[tokio::main]asyncfnmain(){// there is a valid "role" in the system
letrole_data_id=std::env::var("ROLE_DATA_ID").unwrap();// there is a valid "permission" in the system
letpermission_id=std::env::var("PERMISSION_ID").unwrap();letbody=RoleUpdateRequest::new(RoleUpdateData::new(RoleUpdateAttributes::new().name("developers-updated".to_string()),role_data_id.clone(),RolesType::ROLES,).relationships(RoleRelationships::new().permissions(RelationshipToPermissions::new().data(vec![RelationshipToPermissionData::new().id(permission_id.clone()).type_(PermissionsType::PERMISSIONS)]),)),);letconfiguration=datadog::Configuration::new();letapi=RolesAPI::with_config(configuration);letresp=api.update_role(role_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.comddog-gov.comus2.ddog-gov.com"DD_API_KEY="<DD_API_KEY>"DD_APP_KEY="<DD_APP_KEY>"cargo run
/**
* Update a role returns "OK" response
*/import{client,v2}from"@datadog/datadog-api-client";constconfiguration=client.createConfiguration();constapiInstance=newv2.RolesApi(configuration);// there is a valid "role" in the system
constROLE_DATA_ID=process.env.ROLE_DATA_IDasstring;// there is a valid "permission" in the system
constPERMISSION_ID=process.env.PERMISSION_IDasstring;constparams: v2.RolesApiUpdateRoleRequest={body:{data:{id: ROLE_DATA_ID,type:"roles",attributes:{name:"developers-updated",},relationships:{permissions:{data:[{id: PERMISSION_ID,type:"permissions",},],},},},},roleId: ROLE_DATA_ID,};apiInstance.updateRole(params).then((data: v2.RoleUpdateResponse)=>{console.log("API called successfully. Returned data: "+JSON.stringify(data));}).catch((error: any)=>console.error(error));