Roles

Gets a roles within the organization.

get

Authorizations

BearerAuth

X-API-KeystringRequired

Responses

200

OK

application/json

created_bystringOptional

created_onintegerOptional

defaultbooleanOptional

descriptionstringOptional

idstringOptional

is_activebooleanOptional

namestringOptional

updated_bystringOptional

updated_onintegerOptional

204

No Content

get

/organization/v1/roles

HTTPcURLJavaScriptPython

GET /organization/v1/roles HTTP/1.1
Host: api.skysql.com/
X-API-Key: YOUR_API_KEY
Accept: */*

[
  {
    "created_by": "text",
    "created_on": 1,
    "default": true,
    "description": "text",
    "id": "text",
    "is_active": true,
    "name": "text",
    "updated_by": "text",
    "updated_on": 1
  }
]

Gets a role by role id within the organization.

get

Authorizations

BearerAuth

X-API-KeystringRequired

Path parameters

role_idstringRequired

Role identifier

Responses

200

OK

application/json

created_bystringOptional

created_onintegerOptional

defaultbooleanOptional

descriptionstringOptional

idstringOptional

is_activebooleanOptional

namestringOptional

updated_bystringOptional

updated_onintegerOptional

get

/organization/v1/roles/{role_id}

HTTPcURLJavaScriptPython

GET /organization/v1/roles/{role_id} HTTP/1.1
Host: api.skysql.com/
X-API-Key: YOUR_API_KEY
Accept: */*

200

OK

{
  "created_by": "text",
  "created_on": 1,
  "default": true,
  "description": "text",
  "id": "text",
  "is_active": true,
  "name": "text",
  "updated_by": "text",
  "updated_on": 1
}