Jump to

• Request
• Response

List Audit Log Event Subscriptions

get

/restproxy/api/v2/auditlog/event-subscriptions

Lists all audit log event subscriptions.

Request

Supported Media Types

• application/json

Query Parameters

• subscription-id: string
  ID of the subscription when successful.
• user-id: string
  User's name. It should be the same user defined in basic auth.

Back to Top

Response

Supported Media Types

• application/json

200 Response

Successful operation

Body ()

Root Schema : schema

Type: object

Show Source

• error(optional): string
  Default Value:

  Error message when the request fails
• result(optional): array result
• returnCode: string
  Allowed Values: [ "Success", "Failure" ]

{
    "type":"object",
    "required":[
        "returnCode"
    ],
    "properties":{
        "returnCode":{
            "$ref":"#/definitions/returnCode"
        },
        "error":{
            "type":"string",
            "description":"Error message when the request fails",
            "default":""
        },
        "result":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/AuditLogEventSubscription"
            }
        }
    }
}

Nested Schema : result

Type: array

Show Source

• Array of: object AuditLogEventSubscription

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

Nested Schema : AuditLogEventSubscription

Type: object

Show Source

• action(optional): string
  Name of audit log action
• callbackTLSCerts: object callbackTLSCerts
• callbackURL: string
  URL to callback
• expires(optional): string
  Expiration of the subscription
• type: string
  Allowed Values: [ "auditlog" ]

  Audit log event type to subscribe to
• userIdentity(optional): string
  Name of audit log userIdentity

{
    "type":"object",
    "required":[
        "type",
        "callbackURL",
        "callbackTLSCerts"
    ],
    "properties":{
        "type":{
            "description":"Audit log event type to subscribe to",
            "type":"string",
            "enum":[
                "auditlog"
            ]
        },
        "callbackURL":{
            "description":"URL to callback",
            "type":"string"
        },
        "callbackTLSCerts":{
            "type":"object",
            "properties":{
                "caCert":{
                    "type":"string"
                },
                "clientCert":{
                    "type":"string"
                },
                "keyPassword":{
                    "type":"string"
                }
            }
        },
        "expires":{
            "description":"Expiration of the subscription",
            "type":"string"
        },
        "action":{
            "description":"Name of audit log action",
            "type":"string"
        },
        "userIdentity":{
            "description":"Name of audit log userIdentity",
            "type":"string"
        }
    }
}

Nested Schema : callbackTLSCerts

Type: object

Show Source

• caCert(optional): string
• clientCert(optional): string
• keyPassword(optional): string

{
    "type":"object",
    "properties":{
        "caCert":{
            "type":"string"
        },
        "clientCert":{
            "type":"string"
        },
        "keyPassword":{
            "type":"string"
        }
    }
}

400 Response

Bad Request

401 Response

Not authorized

403 Response

Forbidden

404 Response

Invalid parameters

500 Response

Service unavailable

Back to Top