Jump to

• Request
• Response

Get Permitted Routes

get

/authorization

Returns the API routes granted to the current user.

Request

There are no request parameters for this operation.

There's no request body for this operation.

Back to Top

Response

Supported Media Types

• application/xml
• application/json

200 Response

Permitted routes returned.

Body ()

Root Schema : schema

Type: array

Show Source

• Array of: object permittedRoute

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/PermittedRoute"
    }
}

Nested Schema : permittedRoute

Type: object

Show Source

• methods(required): array methods
  The HTTP methods permitted for the route.
• path(required): string
  The permitted API endpoint path.
• pathAlias(required): string
  The route alias derived from the configured authorization resource and action.

{
    "required":[
        "methods",
        "path",
        "pathAlias"
    ],
    "type":"object",
    "properties":{
        "pathAlias":{
            "type":"string",
            "description":"The route alias derived from the configured authorization resource and action."
        },
        "path":{
            "type":"string",
            "description":"The permitted API endpoint path."
        },
        "methods":{
            "type":"array",
            "description":"The HTTP methods permitted for the route.",
            "items":{
                "type":"string",
                "description":"The HTTP methods permitted for the route."
            }
        }
    },
    "xml":{
        "name":"permittedRoute",
        "namespace":"http://xmlns.oracle.com/cgbu/schemas/BusinessObjs"
    }
}

Nested Schema : methods

Type: array

The HTTP methods permitted for the route.

Show Source

• Array of: string
  The HTTP methods permitted for the route.

{
    "type":"array",
    "description":"The HTTP methods permitted for the route.",
    "items":{
        "type":"string",
        "description":"The HTTP methods permitted for the route."
    }
}

403 Response

Access was denied.

500 Response

An internal server error occurred.

Back to Top