Jump to

• Request
• Response

Get the AuthPolicyStatement object by its id.

get

https://{host}:{port}/{basePath}/AuthPolicyStatement/{authPolicyStatementId}

get the AuthPolicyStatement object by its id.

Request

Path Parameters

• AuthPolicyStatementId(required):
  AuthPolicyStatementId to retrieve the associated AuthPolicyStatement.

Header Parameters

• Auth-Token(required): string
  Auth-Token received from a successful login response.
• opc-request-id: string
  Unique identifier for the request

There's no request body for this operation.

Security

• basicAuth: http
  Type: http

Back to Top

Response

Supported Media Types

• application/json

200 Response

Request completed successfully.

Body ()

Root Schema : AuthPolicyStatement

Type: object

Show Source

• action(required): string
  Allowed Values: [ "INSPECT", "READ", "USE", "MANAGE" ]
• activeState(required): string
  Allowed Values: [ "ACTIVE", "INACTIVE" ]
• authorizationGroupId: object AuthorizationGroup
  An authorization group represents a collection of users that share a pca authorization level. The various levels are SuperAdmin, Admin and Monitor.
• faultIds: array faultIds
• functionFamily(required): string
  Maximum Length: 128
• lastModifiedTime: timestamp
• predefined: boolean
• resourceFamily(required): string
  Maximum Length: 128
• resources(required): string
  Maximum Length: 1024

{
    "properties":{
        "action":{
            "description":"",
            "enum":[
                "INSPECT",
                "READ",
                "USE",
                "MANAGE"
            ],
            "type":"string"
        },
        "activeState":{
            "description":"",
            "enum":[
                "ACTIVE",
                "INACTIVE"
            ],
            "type":"string"
        },
        "resourceFamily":{
            "description":"",
            "maxLength":128,
            "type":"string"
        },
        "functionFamily":{
            "description":"",
            "maxLength":128,
            "type":"string"
        },
        "resources":{
            "description":"",
            "maxLength":1024,
            "type":"string"
        },
        "lastModifiedTime":{
            "description":"",
            "type":"timestamp"
        },
        "predefined":{
            "description":"",
            "type":"boolean"
        },
        "authorizationGroupId":{
            "description":"",
            "$ref":"#/components/schemas/AuthorizationGroup"
        },
        "faultIds":{
            "description":"",
            "type":"array"
        }
    },
    "required":[
        "action",
        "activeState",
        "resourceFamily",
        "functionFamily",
        "resources"
    ],
    "type":"object",
    "description":""
}

Nested Schema : AuthorizationGroup

Type: object

An authorization group represents a collection of users that share a pca authorization level. The various levels are SuperAdmin, Admin and Monitor.

Show Source

• authPolicyStatementIds: array authPolicyStatementIds
• cliSessionIds: array cliSessionIds
• faultIds: array faultIds
• name(required): string
  Maximum Length: 128
• policyStatements: array policyStatements
• predefined: boolean
• userIds: array userIds
• webSessionIds: array webSessionIds

{
    "properties":{
        "name":{
            "description":"",
            "maxLength":128,
            "type":"string"
        },
        "policyStatements":{
            "description":"",
            "type":"array"
        },
        "predefined":{
            "description":"",
            "type":"boolean"
        },
        "userIds":{
            "description":"",
            "type":"array"
        },
        "authPolicyStatementIds":{
            "description":"",
            "type":"array"
        },
        "cliSessionIds":{
            "description":"",
            "type":"array"
        },
        "webSessionIds":{
            "description":"",
            "type":"array"
        },
        "faultIds":{
            "description":"",
            "type":"array"
        }
    },
    "required":[
        "name"
    ],
    "type":"object",
    "description":"An authorization group represents a collection of users that share a pca authorization level. The various levels are SuperAdmin, Admin and Monitor."
}

Nested Schema : faultIds

Type: array

Nested Schema : authPolicyStatementIds

Type: array

Nested Schema : cliSessionIds

Type: array

Nested Schema : faultIds

Type: array

Nested Schema : policyStatements

Type: array

Nested Schema : userIds

Type: array

Nested Schema : webSessionIds

Type: array

400 Response

Bad request

Body ()

Root Schema : Error

Type: object

Show Source

• code(required): string
  A short error code that defines the error, meant for programmatic parsing.
• message(required): string
  A human-readable error string.

{
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "type":"string",
            "description":"A short error code that defines the error, meant for programmatic parsing."
        },
        "message":{
            "type":"string",
            "description":"A human-readable error string."
        }
    },
    "type":"object"
}

401 Response

Unauthorized

Body ()

Root Schema : Error

Type: object

Show Source

• code(required): string
  A short error code that defines the error, meant for programmatic parsing.
• message(required): string
  A human-readable error string.

{
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "type":"string",
            "description":"A short error code that defines the error, meant for programmatic parsing."
        },
        "message":{
            "type":"string",
            "description":"A human-readable error string."
        }
    },
    "type":"object"
}

404 Response

Not Found

Body ()

Root Schema : Error

Type: object

Show Source

• code(required): string
  A short error code that defines the error, meant for programmatic parsing.
• message(required): string
  A human-readable error string.

{
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "type":"string",
            "description":"A short error code that defines the error, meant for programmatic parsing."
        },
        "message":{
            "type":"string",
            "description":"A human-readable error string."
        }
    },
    "type":"object"
}

500 Response

Internal Server Error

Body ()

Root Schema : Error

Type: object

Show Source

• code(required): string
  A short error code that defines the error, meant for programmatic parsing.
• message(required): string
  A human-readable error string.

{
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "type":"string",
            "description":"A short error code that defines the error, meant for programmatic parsing."
        },
        "message":{
            "type":"string",
            "description":"A human-readable error string."
        }
    },
    "type":"object"
}

Default Response

An error has occurred

Body ()

Root Schema : Error

Type: object

Show Source

• code(required): string
  A short error code that defines the error, meant for programmatic parsing.
• message(required): string
  A human-readable error string.

{
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "type":"string",
            "description":"A short error code that defines the error, meant for programmatic parsing."
        },
        "message":{
            "type":"string",
            "description":"A human-readable error string."
        }
    },
    "type":"object"
}

Back to Top