Skip to content
  • Auto
  • Light
  • Dark
Get Started

Retrieve

Get
client.IAM.Roles.Get(ctx, roleID) (*RoleRoleIAMRoleGetResponse, error)
get/api/v1/iam/roles/{role_id}

Get a role by id.

Parameters
roleIDstring

The roleId field.

Returns
IAMRoleGetResponsestruct

The GetRolesResponse message contains the retrieved role.

Hide ParametersShow Parameters
RoleIDstringCreatedAtTimeDeletedAtTimeDisplayNamestringNamestringPermissionsarrayServiceRolesarraySystemAPIOnlyboolSystemBuiltinboolUpdatedAtTimeRole
optional

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

Request example Go
package main

import (
  "context"
  "fmt"

  "github.com/stainless-sdks/-go"
  "github.com/stainless-sdks/-go/option"
)

func main() {
  client := conductoronesdk.NewClient(
    option.WithAPIKey("My API Key"),
  )
  role, err := client.IAM.Roles.Get(context.TODO(), "role_id")
  if err != nil {
    panic(err.Error())
  }
  fmt.Printf("%+v\n", role.Role)
}
200 Example
{
  "role": {
    "displayName": "displayName",
    "permissions": [
      "string"
    ],
    "serviceRoles": [
      "string"
    ]
  }
}