ResourceSets
Realm Operations
Resource set resource provider is responsible for managing Resource Sets belonging to a user. Available operations are update, query, read, revoke all action.
Resource path:
/users/{user}/oauth2/resources/sets
Resource version: 1.0
query
Query the collection of the user’s Resource Set.
Usage
am> query ResourceSets --realm Realm --filter filter --user user
Parameters
- --filter
-
A CREST formatted query filter, where "true" will query all. Fields that can be queried: [*]
- --user
-
Resource set resource provider is responsible for managing Resource Sets belonging to a user. Available operations are update, query, read, revoke all action.
read
Read Resource Set from the collection by id.
Usage
am> read ResourceSets --realm Realm --id id --user user
Parameters
- --id
-
The unique identifier for the resource.
- --user
-
Resource set resource provider is responsible for managing Resource Sets belonging to a user. Available operations are update, query, read, revoke all action.
update
Update a Resource Set record.
Usage
am> update ResourceSets --realm Realm --id id --body body --user user
Parameters
- --id
-
The unique identifier for the resource.
- --body
-
The resource in JSON format, described by the following JSON schema:
{ "$schema" : "http://json-schema.org/draft-04/schema#", "description" : "Describes the structure of the OpenAM representation of a user's OAuth Resource Set. For further information see [insert link to the RSR standard], and documentation about UMA in OpenAM.", "type" : "object", "title" : "Resource Set resource schema", "properties" : { "scopes" : { "type" : "array", "title" : "Scopes", "description" : "List of Resource Set scopes.", "items" : { "type" : "string" } }, "_id" : { "type" : "string", "title" : "Resource set id", "description" : "Unique identifier of the Resource Set." }, "resourceServer" : { "type" : "string", "title" : "Resource server", "description" : "The resources server name." }, "labels" : { "type" : "array", "title" : "Resource labels", "description" : "Labels of the resource.", "items" : { "type" : "string" } }, "name" : { "type" : "string", "title" : "Resource name", "description" : "Name of the resource." }, "icon_uri" : { "type" : "string", "title" : "Icon uri", "description" : "Resource icon uri." }, "resourceOwnerId" : { "type" : "string", "title" : "Resource owner", "description" : "Name of the resource owner." }, "type" : { "type" : "string", "title" : "Resource type", "description" : "Type of the resources." } } } - --user
-
Resource set resource provider is responsible for managing Resource Sets belonging to a user. Available operations are update, query, read, revoke all action.