/
Create a role

Create a role

Request

Creates a role that is used to assign permissions to users.

Security
SecretApiKey or JWT
Bodyapplication/jsonrequired

Role resource.

namestring, [ 1 .. 50 ] charactersrequired

Name of the user role.

descriptionstring or null, <= 65535 characters

Description of the role.

aclArray of objects(Acl)required

Access Control List (ACL) information.

allowedIpsArray of strings or null, (ip)(AllowedIps)

List of IP addresses that are permitted access. Private subnets are prohibited. To remove restrictions, set this value to null.

Example:
[
  "153.12.32.33",
  "201.54.122.0/24",
  "2001:0db8:abcd:0012:0000:0000:0000:ffff",
  "2001:db8:abcd:12::0/64"
]
juniorIdsArray of strings

List of role IDs that are included in this role. For example, a role called admin may include the user and manager roles.

curl -i -X POST \
  https://www.rebilly.com/_mock/catalog/all/roles \
  -H 'Content-Type: application/json' \
  -H 'REB-APIKEY: YOUR_API_KEY_HERE' \
  -d '{
    "name": "string",
    "description": "string",
    "acl": [
      {
        "scope": {
          "organizationId": [
            "organizationId-id-1"
          ]
        },
        "permissions": [
          "PostFile",
          "StorefrontGetAccount",
          "StorefrontGetWebsite",
          "StorefrontGetKycDocument",
          "StorefrontPostKycDocument"
        ]
      }
    ],
    "allowedIps": [
      "153.12.32.33",
      "201.54.122.0/24",
      "2001:0db8:abcd:0012:0000:0000:0000:ffff",
      "2001:db8:abcd:12::0/64"
    ],
    "juniorIds": [
      "string"
    ]
  }'

Responses

Role created.

Headers
Locationstring, (uri)

Location of the related resource.

Example:"https://api.rebilly.com/example"
X-RateLimit-Limitinteger

Total number of rate limit tokens for this request within a rate limit period. For more information, see Rate limits.

Example:3600
X-RateLimit-Remaininginteger

Remaining number of rate limit tokens for this request within the rate limit period. For example, in the sandbox environment, rate limits for non-GET endpoints are set at 3000 requests per 10 minutes.

Example:3600
Bodyapplication/json
idstring, <= 50 charactersread-only

ID of the role.

Example:"role_0YVDN2J11HDMX9N8X7DCB4CMX2"
namestring, [ 1 .. 50 ] charactersrequired

Name of the user role.

descriptionstring or null, <= 65535 characters

Description of the role.

aclArray of objects(Acl)required

Access Control List (ACL) information.

allowedIpsArray of strings or null, (ip)(AllowedIps)

List of IP addresses that are permitted access. Private subnets are prohibited. To remove restrictions, set this value to null.

Example:
[
  "153.12.32.33",
  "201.54.122.0/24",
  "2001:0db8:abcd:0012:0000:0000:0000:ffff",
  "2001:db8:abcd:12::0/64"
]
seniorIdsArray of stringsread-only

List of role IDs where this role is used. For example, a role called user may be used in the admin and manager roles.

juniorIdsArray of strings

List of role IDs that are included in this role. For example, a role called admin may include the user and manager roles.

usersCountintegerread-only

Number of users assigned to this role.

createdTimestring, (date-time)(CreatedTime)read-only

Date and time when the resource is created. This value is set automatically when the resource is created.

updatedTimestring, (date-time)(UpdatedTime)read-only

Date and time when the resource is updated. This value is set automatically when the resource is updated.

_embeddedobjectread-only

Embedded objects that are requested by the expand query parameter.

Response
{
  "id": "role_0YVDN2J11HDMX9N8X7DCB4CMX2",
  "name": "string",
  "description": "string",
  "acl": [
    { … }
  ],
  "allowedIps": [
    "153.12.32.33",
    "201.54.122.0/24",
    "2001:0db8:abcd:0012:0000:0000:0000:ffff",
    "2001:db8:abcd:12::0/64"
  ],
  "seniorIds": [
    "string"
  ],
  "juniorIds": [
    "string"
  ],
  "usersCount": 0,
  "createdTime": "2019-08-24T14:15:22Z",
  "updatedTime": "2019-08-24T14:15:22Z",
  "_links": [
    { … }
  ],
  "_embedded": {
    "juniors": []
  }
}