Identity Broker REST API Reference

UnboundID Logo

/resourcegroups

This resource is available only to principals with these entitlements: "ROLE_READ_RESOURCEGROUP" "ROLE_BROKER_ADMIN"

Mount Point: /auth/api/v1/resourcegroups/

GET

This operation is available only to principals with these entitlements: "ROLE_READ_RESOURCEGROUP" "ROLE_BROKER_ADMIN"

Retrieve a list of resource groups from the entire set of defined resource groups.

Parameters

name description type default
startIndex The index number of the first item to be provided in the results. A null value is equivalent to 0. query
count The maximum number of items to be provided in the results. A null value signifies no maximum. query
sortBy Specifies how the results should be sorted. Allowed values are defined by com.unboundid.policy.models.Resource#getSortsByEnumValues(). A null value returns items in an unspecified order. query NAME_ASCENDING
filterBy Specifies how filtering will occur. Allowed values are defined in com.unboundid.policy.models.Resource#getFiltersByEnumValues(). query
filter user-supplied input used for filtering. query
excludesList comma-separated list of ids to exclude from results. query
urnFilter optional urn filter to apply in addition to the filtering specified by filterBy and filterInput parameters. query

Response Body

result: resource
media types: application/json

Paged results of all requested resource groups.

Status Codes

code description
200 Success

POST

This operation is available only to principals with these entitlements: "ROLE_CREATE_RESOURCEGROUP" "ROLE_BROKER_ADMIN"

Creates a model object.

Request Body

element: resource
media types: application/json

(no documentation provided)

Response Body

result: resource
media types: application/json

The created model object response.

Status Codes

code description
201 Success
400 Bad Request