Role

Get

Get a role by id.

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

Path parameters

role_idstring required

The roleId field.

Response

The GetRolesResponse message contains the retrieved role.

Changes

Changed in 2 of the 33 revisions of this API.2193

  • f2cf3228f366210See the full diff
    • added c1.api.iam.v1.Role subschema #2 to the role response property oneOf list for the response status 200

      response-property-one-of-added

    • the role response's property type/format changed from object/ to / for status 200

      response-property-type-changed

    • removed the optional property role/createdAt from the response with the 200 status

      response-optional-property-removed

    • removed the optional property role/deletedAt from the response with the 200 status

      response-optional-property-removed

    • removed the optional property role/displayName from the response with the 200 status

      response-optional-property-removed

    • removed the optional property role/id from the response with the 200 status

      response-optional-property-removed

    • removed the optional property role/name from the response with the 200 status

      response-optional-property-removed

    • removed the optional property role/permissions from the response with the 200 status

      response-optional-property-removed

    • removed the optional property role/serviceRoles from the response with the 200 status

      response-optional-property-removed

    • removed the optional property role/systemApiOnly from the response with the 200 status

      response-optional-property-removed

    • removed the optional property role/systemBuiltin from the response with the 200 status

      response-optional-property-removed

    • removed the optional property role/updatedAt from the response with the 200 status

      response-optional-property-removed

    This revision also has 1 change that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • 17f9f3bcedd593See the full diff
    • removed the optional property createdAt from the response with the 200 status

      response-optional-property-removed

    • removed the optional property deletedAt from the response with the 200 status

      response-optional-property-removed

    • removed the optional property displayName from the response with the 200 status

      response-optional-property-removed

    • removed the optional property id from the response with the 200 status

      response-optional-property-removed

    • removed the optional property name from the response with the 200 status

      response-optional-property-removed

    • removed the optional property permissions from the response with the 200 status

      response-optional-property-removed

    • removed the optional property serviceRoles from the response with the 200 status

      response-optional-property-removed

    • removed the optional property systemBuiltin from the response with the 200 status

      response-optional-property-removed

    • removed the optional property updatedAt from the response with the 200 status

      response-optional-property-removed

    • api tag Role added

      api-tag-added

    • api tag Roles removed

      api-tag-removed

    • added the optional property role to the response with the 200 status

      response-optional-property-added

    This revision also has 4 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog