Skip to content

User Roles

The User Roles API enables you to retrieve the set of roles that are available to the authenticated acting user within their program. Roles represent permission levels and access scopes for users across the Firstup platform. For example granting access to Creator Studio, content publishing tools, or member experience features.


Resources
Operations

Return a list of roles

Request

Returns a list of all accessible roles in the actor's program. Only primary roles are currently available.

Security
oauth2_as_a_server(Required scopes: users.read) or oauth2_as_a_user(Required scopes: users.read)
Query
originstring

Optional parameter to receive only either "custom" or "system" roles, using the SCIM filter form and the operator eq.

Examples:

  • ?filter=origin eq "custom" (URL-encoded as ?filter=origin%20eq%20%22custom%22)
  • ?filter=origin eq "system" (URL-encoded as ?filter=origin%20eq%20%22system%22)
curl -i -X GET \
  'https://partner.socialchorus.com/scim/v2/Roles?origin=string' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

Success

Bodyapplication/scim+json
schemasArray of strings
Example:
[
  "urn:ietf:params:scim:api:messages:2.0:ListResponse"
]
ResourcesArray of objects(Scim.Role.Resource)
Response
{
  "schemas": [
    "urn:ietf:params:scim:api:messages:2.0:ListResponse"
  ],
  "Resources": [
    { … }
  ]
}