POST /roles

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

Servers

https://api-sandbox.rebilly.com/organizations/{organizationId}
https://api.rebilly.com/organizations/{organizationId}

Request headers

Name	Type	Required	Description
`Content-Type`	String	Yes	The media type of the request body. Default value: "application/json"

Request body fields

Name	Type	Required	Description
`id`	String	No	ID of the role.
`_links[]`	Array	No	Related links.
`_links[].href`	String	No	Link URL.
`_links[].rel`	String	No	Type of link. Valid values: `"juniorRoles"` `"seniorRoles"` `"self"`
`usersCount`	Integer	No	Number of users assigned to this role.
`_embedded`	Object	No	Embedded objects that are requested by the `expand` query parameter.
`_embedded.juniors[]`	Array	No
`name`	String	Yes	Name of the user role.
`description`	String	No	Description of the role.
`updatedTime`	String	No	Date and time when the batch was last updated.
`createdTime`	String	No	Date and time when the batch was created.
`allowedIps[]`	Array	No	List of IP addresses that are permitted access. Private subnets are prohibited. To remove restrictions, set this value to `null`.
`seniorIds[]`	Array	No	List of role IDs where this role is used. For example, a role called `user` may be used in the `admin` and `manager` roles.
`acl[]`	Array	Yes	Access Control List (ACL) information.
`acl[].scope`	Object	Yes	Scope of the API key.
`acl[].scope.customFieldName[]`	Array	No	Array of custom field names.
`acl[].scope.productId[]`	Array	No	Array of product IDs.
`acl[].scope.planId[]`	Array	No	Array of plan IDs.
`acl[].scope.organizationId[]`	Array	No	Array of account IDs.
`acl[].permissions[]`	Array	Yes	If you are creating a restricted API key, use this field to specify individual permissions. Use the wildcard character `*` to provide full access.
`juniorIds[]`	Array	No	List of role IDs that are included in this role. For example, a role called `admin` may include the `user` and `manager` roles.

How to start integrating

Add HTTP Task to your workflow definition.
Search for the API you want to integrate with and click on the name.
- This loads the API reference documentation and prepares the Http request settings.
Click Test request to test run your request to the API and see the API's response.