HomeGuidesAPI Reference
GuidesAPI ReferenceGitHubAirheads Developer CommunityLog In
API Reference

Create role restrictions for given service at global or group

Role restriction for this service at global or group scope

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
enum
required

Defines the type of configuration node to which the config is being applied.

Allowed:
string
required

The identifier of the configuration node(aka group). For node-type GLOBAL, node-id should be 'GLOBAL'. For node-type 'GROUP', node-id should be set to the group-name

string
required

Name of the Airgroup service. This should refer to one of the pre-defined services or a custom-service that has been defined by user.

Body Params

JSON representation of role_restrictions config

disallowed_roles
array of objects
length ≤ 20

List of disallowed user Roles for this service. This must be empty if any roles are configured in 'allowed_roles'

disallowed_roles
allowed_roles
array of objects
length ≤ 20

List of allowed user Roles for this service. This must be empty if any roles are configured in 'disallowed_roles'

allowed_roles
Responses

401

Unauthorized

403

Forbidden

413

Request-size limit exceeded

417

Request-size limit exceeded

429

API Rate limit exceeded

Language
Credentials
Bearer
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json