Retrieve

Get

client.iam.roles.retrieve(stringroleID, RequestOptionsoptions?): roleRoleRoleRetrieveResponse

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

Get a role by id.

Parameters

roleIDstring

The roleId field.

Returns

RoleRetrieveResponse

The GetRolesResponse message contains the retrieved 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.retrieve('role_id');

console.log(role.role);

200 Example

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