API Document

/host/rsrc/resource_set

Overview

/host/rsrc/resource_set{rsid}

deleteResourceSet

DELETE /host/rsrc/resource_set{rsid}

Deletes a previously registered resource set description using the DELETE method, thereby removing it from the authorization server's protection regime.

URL
http://gluu.org/host/rsrc/resource_set{rsid}
Parameters

  • path

    Parameter Required Description Data Type
    rsid true Resource set description ID string
    - header

    Parameter Required Description Data Type
    Authorization false string

Response

ResourceSet

Errors

Status Code Reason
401 Unauthorized

getResourceSet

GET /host/rsrc/resource_set{rsid}

Reads a previously registered resource set description using the GET method. If the request is successful, the authorization server MUST respond with a status message that includes a body containing the referenced resource set description, along with an "_id" property.

URL
http://gluu.org/host/rsrc/resource_set{rsid}
Parameters

  • path

    Parameter Required Description Data Type
    rsid true Resource set description object ID string
    - header

    Parameter Required Description Data Type
    Authorization false string

Response

ResourceSet

Errors

Status Code Reason
401 Unauthorized

updateResourceSet

PUT /host/rsrc/resource_set{rsid}

Updates a previously registered resource set description using the PUT method. If the request is successful, the authorization server MUST respond with a status message that includes an "_id" property.

URL
http://gluu.org/host/rsrc/resource_set{rsid}
Parameters

  • body

    Parameter Required Description Data Type
    body true Resource set description JSON object ResourceSet
    - path

    Parameter Required Description Data Type
    rsid true Resource set description ID string
    - header

    Parameter Required Description Data Type
    Authorization false string

Response

Errors

Status Code Reason
401 Unauthorized

/host/rsrc/resource_set

getResourceSetList

GET /host/rsrc/resource_set

Lists all previously registered resource set identifiers for this user using the GET method. The authorization server MUST return the list in the form of a JSON array of {rsid} string values.

The resource server uses this method as a first step in checking whether its understanding of protected resources is in full synchronization with the authorization server's understanding.

URL
http://gluu.org/host/rsrc/resource_set
Parameters

  • query

    Parameter Required Description Data Type
    scope false Scope uri string
    - header

    Parameter Required Description Data Type
    Authorization false string

Response

ResourceSet

Errors

Status Code Reason
401 Unauthorized

createResourceSet

POST /host/rsrc/resource_set

Adds a new resource set description using the POST method. If the request is successful, the authorization server MUST respond with a status message that includes an _id property.

URL
http://gluu.org/host/rsrc/resource_set
Parameters

  • body

    Parameter Required Description Data Type
    body true Resource set description ResourceSet
    - header

    Parameter Required Description Data Type
    Authorization false string

Response

Errors

Status Code Reason
401 Unauthorized

unsupportedHeadMethod

HEAD /host/rsrc/resource_set

Not allowed

URL
http://gluu.org/host/rsrc/resource_set
Parameters
Response

Errors

Status Code Reason

unsupportedOptionsMethod

OPTIONS /host/rsrc/resource_set

Not allowed

URL
http://gluu.org/host/rsrc/resource_set
Parameters
Response

Errors

Status Code Reason

Data Types

ResourceSet

type required access description notes
string optional - - -
string optional - - -
string optional - - -
Array[string] optional - - -
string optional - - -