Skip to content
Baack

Role

A role in role based access control context which can be associated with various actors

Browse the docs

Endpoints

  • GET/n/v1/role/{urn}

    Endpoint for managing roles with permissions for Role based access control. Roles can be associated with multiple identities and api clients to grant a role based permission set to associated resources

    Parameters

    urn (path, required)
    String representation of a Unique Resource Name. Typically a UUID with 36 characters.

    Responses

    200 OK
    returns RoleREAD_SUCCESS
    404 Not found
    returns ErrorNOT_FOUND
    curl -H "Authorization: Bearer $BAACK_API_TOKEN" \
      https://api.baack.co/n/v1/role/{urn}

Fields

Role fields
FieldTypeDescription
urnstring (uuid)
ownerCompany

Required on create.

identitiesarray of Identity

Ignored on update.

clientsarray of API Client

Ignored on update.

namestring