UmaResourceSetLabels

Realm Operations

Provides create, delete and query operations for UMA resource set labels

Resource path: /users/{user}/oauth2/resources/labels

Resource version: 1.0

create

Creates a UMA Resource Set Label

Usage:

am> create UmaResourceSetLabels --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:

{
  "description" : "Represents a UMA Resource Set Label",
  "id" : "urn:jsonschema:org:forgerock:openam:oauth2:resources:labels:ResourceSetLabel",
  "type" : "object",
  "title" : "UMA Resource Set Label",
  "properties" : {
    "id" : {
      "type" : "string",
      "description" : "The unique identifier of the resource set label",
      "title" : "Id"
    },
    "name" : {
      "type" : "string",
      "description" : "The displayed text of the label",
      "title" : "Name"
    },
    "type" : {
      "type" : "string",
      "description" : "The type of the label e.g. 'System'",
      "title" : "Type",
      "enum" : [ "STAR", "USER", "SYSTEM" ]
    },
    "resourceSetIds" : {
      "type" : "array",
      "items" : {
        "type" : "string"
      }
    }
  }
}

--user

Provides create, delete and query operations for UMA resource set labels

delete

Deletes a UMA Resource Set Label

Usage:

am> delete UmaResourceSetLabels --realm Realm --id id --user user

Parameters:

--id: The unique identifier for the resource.
--user: Provides create, delete and query operations for UMA resource set labels

query

Queries the collection of UMA labels

Usage:

am> query UmaResourceSetLabels --realm Realm --filter filter --user user

Parameters:

--filter: A CREST formatted query filter, where "true" will query all. Fields that can be queried: [*]
--user: Provides create, delete and query operations for UMA resource set labels