Get

Get a role by id.

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

Get

Go

package main

import(
	"context"
	"github.com/conductorone/conductorone-sdk-go/pkg/models/shared"
	conductoronesdkgo "github.com/conductorone/conductorone-sdk-go"
	"github.com/conductorone/conductorone-sdk-go/pkg/models/operations"
	"log"
)

func main() {
    ctx := context.Background()

    s := conductoronesdkgo.New(
        conductoronesdkgo.WithSecurity(shared.Security{
            BearerAuth: "<YOUR_BEARER_TOKEN_HERE>",
            Oauth: "<YOUR_OAUTH_HERE>",
        }),
    )

    res, err := s.Roles.Get(ctx, operations.C1APIIamV1RolesGetRequest{
        RoleID: "<id>",
    })
    if err != nil {
        log.Fatal(err)
    }
    if res.GetRolesResponse != nil {
        // handle response
    }
}

200

{
  "role": {
    "createdAt": "2023-11-07T05:31:56Z",
    "deletedAt": "2023-11-07T05:31:56Z",
    "displayName": "<string>",
    "id": "<string>",
    "name": "<string>",
    "permissions": [
      "<string>"
    ],
    "serviceRoles": [
      "<string>"
    ],
    "systemApiOnly": true,
    "systemBuiltin": true,
    "updatedAt": "2023-11-07T05:31:56Z"
  }
}

Authorizations

Authorization · string · header · required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Authorization · string · header · required

This API uses OAuth2 with the Client Credential flow. Client Credentials must be sent in the BODY, not the headers. For an example of how to implement this, refer to the c1TokenSource.Token() function.

Path Parameters

role_id · string · required

The roleId field.

Response

200 - application/json

The GetRolesResponse message contains the retrieved role.

The GetRolesResponse message contains the retrieved role.

role · Role · object

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

Show child attributes