Update

Update

client.iam.roles.update(stringroleID, RoleUpdateParamsbody?, RequestOptionsoptions?): roleRoleRoleUpdateResponse

post/api/v1/iam/roles/{role_id}

Update a role by passing a Role object.

Parameters

roleIDstring

The id of the role.

bodyroleRoleupdateMaskunionRoleUpdateParams

Hide ParametersShow Parameters

roleidstringcreatedAtstringdeletedAtstringdisplayNamestringnamestringpermissionsunionserviceRolesunionsystemApiOnlybooleansystemBuiltinbooleanupdatedAtstringRole

optional

Role is a role that can be assigned to a user in ConductorOne.

updateMaskunion

optional

string | null

Returns

RoleUpdateResponse

UpdateRolesResponse is the response message containing the updated role.

Hide ParametersShow Parameters

roleidstringcreatedAtstringdeletedAtstringdisplayNamestringnamestringpermissionsunionserviceRolesunionsystemApiOnlybooleansystemBuiltinbooleanupdatedAtstringRole

optional

Role is a role that can be assigned to a user in ConductorOne.

Request example TypeScript

import ConductoroneSDK from 'conductorone-sdk';

const client = new ConductoroneSDK({
  apiKey: 'My API Key',
});

const role = await client.iam.roles.update('role_id');

console.log(role.role);

200 Example

{
  "role": {
    "displayName": "displayName",
    "permissions": [
      "string"
    ],
    "serviceRoles": [
      "string"
    ]
  }
}