Skip to main content
POST

Authorizations

Authorization
string
header
required

A StarTree API token or a service token (st-<accessKey>-<secretKey>).

Path Parameters

roleSrn
string
required

SRN of the role, with # encoded as %23.

Body

application/json
subject
string
required

The user email, group name, domain, or service token access key, depending on subjectType.

Example:

"jane.doe@example.com"

subjectType
enum<string>
required
  • user-email: an individual user's email address.
  • group: the name of a group in your identity provider.
  • domain: an email domain, such as example.com.
  • service-token: a service token, identified by its access key (the 16 characters between st- and the next -).
Available options:
user-email,
group,
domain,
service-token
metadata
object

Optional key-value metadata stored with the assignment.

Response

Role assigned. The response body is empty.