Get Role

Gets project role details.

A role bundles one or more policies and is assigned to users to control what they can do — this is Norbix's role-based access control (RBAC). Roles are project-scoped and managed in the Membership module.

This endpoint returns a single role by id.

Gets project role details.

get

Authorizations

Bearer

HTTPRequired

JWT Bearer Authorization

Path parameters

versionstring · nullableRequired

The CodeMash API version used to fetch data from the API. If not specified, the last version will be used. E.g.: v3

Query parameters

Idstring · nullableRequired

Role id from get_roles.

Header parameters

norbix-project-idstring · nullableRequired

ID of your project. Can be passed in a header as norbix-project-id.

norbix-envstring · nullableOptional

Target environment for this request (e.g. TEST, STAGING). Optional — when omitted the request runs against PROD. Can be passed in a header as norbix-env.

CultureCodestring · nullableOptional

Specify culture code when your response from the API should be localised. E.g.: en

TimeZoneIdstring · nullableOptional

TimeZone

CorrelationIdstring · nullableOptional

CorrelationId for each request

Responses

200

OK

application/json

get/{version}/membership/roles/{Id}

HTTPcURLJavaScriptPython

GET /{version}/membership/roles/{Id}?Id=text HTTP/1.1
Host: hub.norbix.ai
Authorization: Bearer YOUR_SECRET_TOKEN
norbix-project-id: text
Accept: */*

200

OK

{
  "responseStatus": {
    "isSuccess": true
  },
  "role": {
    "id": "text",
    "name": "text",
    "displayName": "text",
    "description": "text",
    "isSystem": true,
    "attachedPolicies": []
  }
}

In the dashboard

Manage this visually in Norbix Cloud — see Membership → Roles.

Use it from code

Every Norbix SDK exposes this endpoint as a method — see Get Role in the SDK reference, with examples in every language.