Get role by ID

GET

/api/security/roles/{id}

const url = 'https://example.com/api/security/roles/example';
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request GET \
  --url https://example.com/api/security/roles/example \
  --header 'Authorization: Bearer <token>'

Retrieves a specific role

Authorizations

bearerAuth

Parameters

Path Parameters

required

Role ID

string

Responses

200

Role retrieved successfully

application/json

object

required

Role ID

string

searchId

required

Searchable ID

string

name

required

Role name

string

groups

Groups with this role

Array<string>

default:

users

Users with this role

Array<string>

default:

repos

Repository permissions (legacy coarse model)

Array<object>

default:

object

CACHE_ROOT

required

Repository namespace

string

required

Repository ID

string

permission

required

Permission level (view, write, admin)

string

type

Entity type

string

default: role

description

Role description

string

bundles

Permission bundle IDs this role inherits from

Array<string>

default:

permissions

Granular permission grants on this role, in addition to bundle-derived permissions

object

global

Permission keys held by this role at global scope

Array<string>

default:

repos

Per-repo permission grants keyed by repo ID. Type-qualified entries take the form ‘:’.

object

key

additional properties

Array<string>

sites

Per-site permission grants keyed by site ID

object

key

additional properties

Array<string>

overrides

Global grant/revoke applied on top of bundle and per-scope permissions

object

grant

Permission keys granted in addition to bundles, applied globally

Array<string>

default:

revoke

Permission keys revoked from the bundle-derived set, applied globally

Array<string>

default:

Example

{
  "id": "editor",
  "searchId": "editor",
  "name": "Editor",
  "groups": [],
  "users": [],
  "repos": [],
  "type": "role",
  "description": "",
  "bundles": [],
  "permissions": {
    "global": [],
    "repos": {},
    "sites": {}
  },
  "overrides": {
    "grant": [],
    "revoke": []
  }
}

404

Role not found