Dev guideRecipesAPI ReferenceChangelog
Dev guideRecipesUser GuidesNuGetDev CommunityOptimizely AcademySubmit a ticketLog In
API Reference

Get roles

Get a page of roles.

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

Name of the role.

string

Description of the role.

string

Product ID of the role.

string

Organization ID assigned to the experimental roles.

string | null

Type of role. Possible values: 0 for Product Defined, 1 for Customer Defined for Product, 2 for Customer Defined for Product Instance.

string

Owner of the role.

targetIds
array of strings

IDs of the targets associated with the role, like the IDs of products or instances.

targetIds
boolean | null

True or false, indicating whether the role is active.

properties
array of objects

Properties defined in the role.

properties
string
boolean | null

True or false, indicating whether to exclude Teams roles from the results. Defaults to true.

int32

Number of results to include per page.

int32

Offset paging of results.

Responses

401

Unauthorized access to endpoint.

403

Forbidden access to endpoint.

500

A server error occurred, please try again.

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