Users Assigned to Ring Group

📘

Supported Regions and Base URLs

Scope

user-ring-groups:read

Body Response - Schema

200 (list of users assigned to ring group)

ParameterTypeDescription
totalintegern/a
pageintegern/a
per_pageintegern/a
countintegern/a
ring_groupstringn/a
_embeddedobjectA subset of the list of users for the ring group. "_embedded" subdivides into:

1 - "users" (array[object]), which subdivides into:
1.1 - "id" (string) - the ID of the user (required)
1.2 - "_links" (object) - the defined links (required)
_linksobjectHAL API related links. "_links" subdivides into:

1 - "self" (object), which subdivides into:
1.1 - "href" (string)

2 - "next" (object), which subdivides into:
2.1 - "href" (string)

3 - "previous" (object), which subdivides into:
3.1 - "href" (string)

4 - "page" (object), which subdivides into:
4.1 - "templated" (boolean)
4.2 - "href" (string)

401 (the request does not contain one of the mandatory headers), 403 (the user is authenticated but does not have sufficient permissions to perform the action), 404 (not found)

ParameterTypeDescriptionRequired
codestringn/ayes
messagestringn/ayes
descriptionstringn/ano
fieldsarray[object]"fields" subdivides into:

"name" (string)

"description" (string)
yes (name and description)
Language
Click Try It! to start a request and see the response here!