Jump to

• Request
• Response
• Examples

Get grants issued for an application

get

/developers/services/v1/applications/{id}/grants

Returns a collection of grants that have been issued for the {appId} application. By default, the grant type, role, and user or group ID for users or groups issued each grant are returned. Additional fields can be returned by sending any of these field names, separated by commas, in the fields query parameter: createdAt, createdBy, user.roles, and group.roles.

Any authenticated user issued the Manage Application or View All Details grants for the application can access this resource.

Request

Path Parameters

• appId: string
  A unique ID referencing a specific application.

Query Parameters

• fields(optional): array
  Collection Format: csv

  Pass optional fields, separated by commas, in this parameter to return them in the response. See the operation's description for a list of field values.

  • [0]: string

  {
      "name":"fields",
      "in":"query",
      "description":"Pass optional fields, separated by commas, in this parameter to return them in the response. See the operation's description for a list of field values.",
      "required":false,
      "type":"array",
      "items":{
          "type":"string"
      },
      "collectionFormat":"csv"
  }

• links(optional): array
  Collection Format: csv

  Filter the specified link rel's.

  • [0]: string

  {
      "name":"links",
      "in":"query",
      "description":"Filter the specified link rel's.",
      "required":false,
      "type":"array",
      "items":{
          "type":"string"
      },
      "collectionFormat":"csv"
  }

Back to Top

Response

200 Response

The collection of grants

Body ()

Root Schema : GetGrantsResponse

Match All

Show Source

• object CollectionResponseFeature
• object LinksResponseFeature
• object GetGrantsResponse-allOf[2]

{
    "allOf":[
        {
            "$ref":"#/definitions/CollectionResponseFeature"
        },
        {
            "$ref":"#/definitions/LinksResponseFeature"
        },
        {
            "type":"object",
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "$ref":"#/definitions/GetGrantsItem"
                    }
                }
            }
        }
    ]
}

Nested Schema : CollectionResponseFeature

Type: object

Show Source

• count(optional): integer(int32)
  The number of items in this collection.

{
    "properties":{
        "count":{
            "type":"integer",
            "format":"int32",
            "description":"The number of items in this collection."
        }
    }
}

Nested Schema : LinksResponseFeature

Type: object

Show Source

• links(optional): array links
  Includes 'canonical'.

{
    "properties":{
        "links":{
            "type":"array",
            "description":"Includes 'canonical'.",
            "items":{
                "$ref":"#/definitions/HATEOASLink"
            }
        }
    }
}

Nested Schema : GetGrantsResponse-allOf[2]

Type: object

Show Source

• items(optional): array items

{
    "type":"object",
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/GetGrantsItem"
            }
        }
    }
}

Nested Schema : links

Type: array

Includes 'canonical'.

Show Source

• Array of: object HATEOASLink

{
    "type":"array",
    "description":"Includes 'canonical'.",
    "items":{
        "$ref":"#/definitions/HATEOASLink"
    }
}

Nested Schema : HATEOASLink

Type: object

Show Source

• href(optional): string
  Link href.
• method(optional): string
  HTTP Operation GET, POST, PUT
• rel(optional): string
  Link relation.

{
    "type":"object",
    "properties":{
        "method":{
            "type":"string",
            "description":"HTTP Operation GET, POST, PUT"
        },
        "rel":{
            "type":"string",
            "description":"Link relation."
        },
        "href":{
            "type":"string",
            "description":"Link href."
        }
    }
}

Nested Schema : items

Type: array

Show Source

• Array of: GetGrantsItem

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/GetGrantsItem"
    }
}

Nested Schema : GetGrantsItem

Match All

Show Source

• object Grant
• object ResourceLinksProperties

{
    "allOf":[
        {
            "$ref":"#/definitions/Grant"
        },
        {
            "$ref":"#/definitions/ResourceLinksProperties"
        }
    ]
}

Nested Schema : Grant

Type: object

Show Source

• createdAt(optional): string
  The date and time the grant was issued.
• createdBy(optional): string
  The user who issued the grant.
• group(optional): object Group
• type: string
  The grant type's name.
• user(optional): object User

{
    "type":"object",
    "required":[
        "type"
    ],
    "properties":{
        "createdAt":{
            "type":"string",
            "description":"The date and time the grant was issued."
        },
        "createdBy":{
            "type":"string",
            "description":"The user who issued the grant."
        },
        "type":{
            "type":"string",
            "description":"The grant type's name."
        },
        "user":{
            "$ref":"#/definitions/User"
        },
        "group":{
            "$ref":"#/definitions/Group"
        }
    }
}

Nested Schema : ResourceLinksProperties

Type: object

Show Source

• links(optional): array links
  Includes 'canonical'.

{
    "properties":{
        "links":{
            "type":"array",
            "description":"Includes 'canonical'.",
            "items":{
                "$ref":"#/definitions/HATEOASLink"
            }
        }
    }
}

Nested Schema : Group

Type: object

Show Source

• id: string
  The group's ID.

{
    "type":"object",
    "required":[
        "id"
    ],
    "properties":{
        "id":{
            "type":"string",
            "description":"The group's ID."
        }
    }
}

Nested Schema : User

Type: object

Show Source

• id: string
  The user's ID.

{
    "type":"object",
    "required":[
        "id"
    ],
    "properties":{
        "id":{
            "type":"string",
            "description":"The user's ID."
        }
    }
}

Nested Schema : links

Type: array

Includes 'canonical'.

Show Source

• Array of: object HATEOASLink

{
    "type":"array",
    "description":"Includes 'canonical'.",
    "items":{
        "$ref":"#/definitions/HATEOASLink"
    }
}

403 Response

Forbidden.

Body ()

Root Schema : Error

Type: object

Show Source

• detail(optional): string
  Detailed error message
• errorCode(optional): string
  Application specific error code
• errorDetails(optional): array errorDetails
  additional errors
• errorPath(optional): string
• instance(optional): string
  URI to the link that provides more detail about the error
• status(optional): string
  HTTP status code
• title: string
  Summary error message
• type: string
  Error type

{
    "type":"object",
    "required":[
        "title",
        "type"
    ],
    "properties":{
        "instance":{
            "type":"string",
            "description":"URI to the link that provides more detail about the error"
        },
        "errorCode":{
            "type":"string",
            "description":"Application specific error code"
        },
        "detail":{
            "type":"string",
            "description":"Detailed error message"
        },
        "type":{
            "type":"string",
            "description":"Error type"
        },
        "title":{
            "type":"string",
            "description":"Summary error message"
        },
        "errorPath":{
            "type":"string"
        },
        "status":{
            "type":"string",
            "description":"HTTP status code"
        },
        "errorDetails":{
            "type":"array",
            "description":"additional errors",
            "items":{
                "$ref":"#/definitions/Error"
            }
        }
    }
}

Nested Schema : errorDetails

Type: array

additional errors

Show Source

• Array of: object Error

{
    "type":"array",
    "description":"additional errors",
    "items":{
        "$ref":"#/definitions/Error"
    }
}

500 Response

Unexpected error.

Body ()

Root Schema : Error

Type: object

Show Source

• detail(optional): string
  Detailed error message
• errorCode(optional): string
  Application specific error code
• errorDetails(optional): array errorDetails
  additional errors
• errorPath(optional): string
• instance(optional): string
  URI to the link that provides more detail about the error
• status(optional): string
  HTTP status code
• title: string
  Summary error message
• type: string
  Error type

{
    "type":"object",
    "required":[
        "title",
        "type"
    ],
    "properties":{
        "instance":{
            "type":"string",
            "description":"URI to the link that provides more detail about the error"
        },
        "errorCode":{
            "type":"string",
            "description":"Application specific error code"
        },
        "detail":{
            "type":"string",
            "description":"Detailed error message"
        },
        "type":{
            "type":"string",
            "description":"Error type"
        },
        "title":{
            "type":"string",
            "description":"Summary error message"
        },
        "errorPath":{
            "type":"string"
        },
        "status":{
            "type":"string",
            "description":"HTTP status code"
        },
        "errorDetails":{
            "type":"array",
            "description":"additional errors",
            "items":{
                "$ref":"#/definitions/Error"
            }
        }
    }
}

Nested Schema : errorDetails

Type: array

additional errors

Show Source

• Array of: object Error

{
    "type":"array",
    "description":"additional errors",
    "items":{
        "$ref":"#/definitions/Error"
    }
}

Back to Top

Examples

The following example shows how to retrieve collection of grants that have been issued for the {appId} application by submitting a GET request on the REST resource using cURL. For more information about cURL, see Use cURL

curl -i -X GET 
-u apicsadmin:password
https://example.com:443/developers/services/v1/applications/{id}/grants

{id} is the unique ID for an application. To retrieve available applications, see Get applications.

Example of Response Headers

The following shows an example of the response headers.

HTTP/1.1 200 OK
Server: Oracle Traffic Director
Date: Wed, 20 Dec 2017 05:19:46 GMT
Content-type: application/json
X-oracle-dms-ecid: 6^3rv0_eR00000000
X-oracle-dms-rid: 0:1

Example of Response Body

The following example shows the contents of the response body in JSON format, including the grant type, role, and user or group ID for users or groups issued each grant.

{
    "offset": 0,
    "count": 1,
    "limit": 128,
    "hasMore": false,
    "links": [
        {
            "templated": "true",
            "method": "GET",
            "rel": "self",
            "href": "http://example.com:443/developers/services/v1/applications/110/grants"
        },
        {
            "templated": "true",
            "method": "GET",
            "rel": "canonical",
            "href": "http://example.com:443/developers/services/v1/applications/110/grants"
        },
        {
            "method": "GET",
            "rel": "types",
            "href": "http://example.com:443/developers/services/v1/applications/grants/types"
        },
        {
            "templated": "true",
            "method": "POST",
            "rel": "create",
            "href": "http://example.com:443/developers/services/v1/applications/110/grants",
            "grant": "ManageApplicationGrant"
        },
        {
            "templated": "true",
            "method": "POST",
            "rel": "create",
            "href": "http://example.com:443/developers/services/v1/applications/110/grants",
            "grant": "ViewAllDetailsApplicationGrant"
        }
    ],
    "items": [
        {
            "createdAt": "2017-12-20T22:30:24-0800",
            "createdBy": "weblogic",
            "links": [
                {
                    "templated": "true",
                    "method": "DELETE",
                    "rel": "delete",
                    "href": "http://example.com:443/developers/services/v1/applications/110/grants/ManageApplicationGrant/users/weblogic"
                }
            ],
            "type": "ManageApplicationGrant",
            "user": {
                "roles": [
                    "Administrator"
                ],
                "id": "apicsadmin"
            }
        }
    ]
}

Back to Top