Jump to

• Request
• Response
• Examples

Revoke a gateway grant from a group

delete

/apiplatform/management/v1/gateways/{gwId}/grants/{grantType}/groups/{groupId}

Revokes the {grantType} grant for the {gwId} gateway from the {groupId} group.

Users accessing this resource must be issued the Gateway Manager role and must be issued the Manage Gateway grant for the specified gateway.

Request

Supported Media Types

• application/json

Path Parameters

• grantType: string
  The grant type.
• groupId: string
  A unique ID referencing a specific group.
• gwId: string
  A unique ID referencing a specific gateway.

Back to Top

Response

Supported Media Types

• application/json

204 Response

The grant was deleted.

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":{
        "type":{
            "type":"string",
            "description":"Error type"
        },
        "title":{
            "type":"string",
            "description":"Summary error message"
        },
        "detail":{
            "type":"string",
            "description":"Detailed error message"
        },
        "instance":{
            "type":"string",
            "description":"URI to the link that provides more detail about the error"
        },
        "errorCode":{
            "type":"string",
            "description":"Application specific error code"
        },
        "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":{
        "type":{
            "type":"string",
            "description":"Error type"
        },
        "title":{
            "type":"string",
            "description":"Summary error message"
        },
        "detail":{
            "type":"string",
            "description":"Detailed error message"
        },
        "instance":{
            "type":"string",
            "description":"URI to the link that provides more detail about the error"
        },
        "errorCode":{
            "type":"string",
            "description":"Application specific error code"
        },
        "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 revoke a grant issued for a gateway from a group by submitting a DELETE request on the REST resource using cURL. For more information about cURL, see Use cURL

curl -i -X DELETE 
-H "Authorization: Bearer access_token"
https://example.com/apiplatform/management/v1/{gwId}/grants/{grantType}/users/{groupId}

• {gwId} is the unique of a gateway. To retrieve available gateway Ids, see Get gateways.

• {grantType} is the type of grant issued for a gateway. To retrieve gateway grant types, see Get gateway grants

• {groupId} is the ID of a group eligible to receive the gateway grant. To retrieve groups eligible for gateway grants, see Get eligible grantees.

Example of Response Headers

The following shows an example of the response headers.

HTTP/1.1 204 No Content
Server: Oracle-Traffic-Director/12.2.1.0.0
Date:  Wed, 22 Mar 2017 09:05:16 GMT
X-oracle-dms-ecid:  49d14691-2176-4c99-aed3-38438604f528-00001e72
X-oracle-dms-rid: 0:1
Via: 1.1 otd_opc
Proxy-agent: Oracle-Traffic-Director/12.2.1.0.0

Back to Top