Sign in

v1

latestOpenAPI 3.0.1License2026-07-17467229.7 KB
UMA 2 Resource

Reads a previously registered resource.

Reads a previously registered resource.

get/restv1/host/rsrc/resource_set/{rsid}

Path parameters

rsidstring required

Resource description ID.

Headers

Authorizationstring required

Client Authorization details that contains the access token along with other details.

Response

OK

_idstring required

UMA Resource identifier

namestring

A human-readable string describing a set of one or more resources. This name MAY be used by the authorization server in its resource owner user interface for the resource owner.

uristring

A human-readable string describing the resource

typestring

A string uniquely identifying the semantics of the resource set. For example, if the resource set consists of a single resource that is an identity claim that leverages standardized claim semantics for "verified email address", the value of this property could be an identifying URI for this claim.

scopesstring[]

An array of strings, any of which MAY be a URI, indicating the available scopes for this resource set. URIs MUST resolve to scope descriptions as defined in Section 2.1. Published scope descriptions MAY reside anywhere on the web; a resource server is not required to self-host scope descriptions and may wish to point to standardized scope descriptions residing elsewhere. It is the resource server's responsibility to ensure that scope description documents are accessible to authorization servers through GET calls to support any user interface requirements. The resource server and authorization server are presumed to have separately negotiated any required interpretation of scope handling not conveyed through scope descriptions.

scope_expressionstring
descriptionstring

A human-readable string describing the resource

icon_uristring

A URI for a graphic icon representing the resource set. The referenced icon MAY be used by the authorization server in its resource owner user interface for the resource owner.

iatinteger required

number of seconds since January 1 1970 UTC, indicating when the token was issued at

expinteger required

number of seconds since January 1 1970 UTC, indicating when this token will expire.

Example response

{
  "_id": "KX3A-39WE",
  "icon_uri": "http://www.example.com/icons/sharesocial.png",
  "iat": 1535709072,
  "exp": 1419356238
}