PagingOfSecretAccessModel

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/delinea/main/json-schema/delinea-paging-of-secret-access-model-schema.json",
  "title": "PagingOfSecretAccessModel",
  "description": "Specify paging and sorting options for querying records and returning results",
  "x-generated": "2026-10-03",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/delinea-secretaccessrequests-api-openapi.yml#/components/schemas/PagingOfSecretAccessModel",
  "properties": {
    "batchCount": {
      "description": "Number of result batches available with current query options",
      "type": "integer",
      "format": "int32"
    },
    "currentPage": {
      "description": "Index of current result page",
      "type": "integer",
      "format": "int32"
    },
    "hasNext": {
      "description": "Whether there are any results in additional pages",
      "type": "boolean"
    },
    "hasPrev": {
      "description": "Whether there are any results in previous pages",
      "type": "boolean"
    },
    "nextSkip": {
      "description": "Correct value of 'skip' for the next page of results",
      "type": "integer",
      "format": "int32"
    },
    "pageCount": {
      "description": "Number of result pages available with current query options",
      "type": "integer",
      "format": "int32"
    },
    "prevSkip": {
      "description": "Correct value of 'skip' for the previous page of results",
      "type": "integer",
      "format": "int32"
    },
    "records": {
      "description": "Query results",
      "items": {
        "$ref": "#/$defs/SecretAccessModel"
      },
      "type": "array"
    },
    "severity": {
      "$ref": "#/$defs/Severity"
    },
    "skip": {
      "description": "Number of records to skip before taking results",
      "type": "integer",
      "format": "int32"
    },
    "sortBy": {
      "description": "List of sort properties",
      "items": {
        "$ref": "#/$defs/Sort"
      },
      "type": "array"
    },
    "success": {
      "description": "Whether the query executed successfully",
      "type": "boolean"
    },
    "take": {
      "description": "Maximum number of records to include in results",
      "type": "integer",
      "format": "int32"
    },
    "total": {
      "description": "Total number of results available",
      "type": "integer",
      "format": "int32"
    }
  },
  "type": "object",
  "$defs": {
    "AccessRequestState": {
      "description": "The Status of the request",
      "properties": {},
      "type": "string",
      "enum": [
        "WaitingForRequest",
        "Pending",
        "Approved",
        "Denied",
        "Canceled",
        "Expired"
      ]
    },
    "SecretAccessModel": {
      "description": "The Secret Access model object",
      "properties": {
        "accessRequestWorkflowMapId": {
          "description": "The Id of the Access Request Workflow Map.",
          "type": "integer",
          "format": "int32"
        },
        "approverDisplayName": {
          "description": "The Display Name of the Approver of the request",
          "type": "string"
        },
        "completed": {
          "description": "Indicating if request has been completed",
          "type": "boolean"
        },
        "currentUserRestrictedFromReviewing": {
          "description": "Indicating if current user is restricted from viewing the request",
          "type": [
            "boolean",
            "null"
          ]
        },
        "expirationDate": {
          "description": "The Expiration Date of the request",
          "type": "string",
          "format": "date-time"
        },
        "folderId": {
          "description": "The Folder Id of the Secret associated to the access request.",
          "type": "integer",
          "format": "int32"
        },
        "hasWorkflow": {
          "description": "Indicating if request is associated to a Work Flow",
          "type": "boolean"
        },
        "requestComment": {
          "description": "The Comment of the request.",
          "type": "string"
        },
        "requestDate": {
          "description": "The Date of the request.",
          "type": "string",
          "format": "date-time"
        },
        "requestingUserId": {
          "description": "The Id of the User requesting access.",
          "type": "integer",
          "format": "int32"
        },
        "requestUsername": {
          "description": "The Username of the User requesting access.",
          "type": "string"
        },
        "responseComment": {
          "description": "The Comment of the response to the request",
          "type": "string"
        },
        "responseDate": {
          "description": "The Date of the response to the request",
          "type": "string",
          "format": "date-time"
        },
        "reviewStatusMessage": {
          "description": "The Review Status Message of the request",
          "type": "string"
        },
        "secretAccessRequestId": {
          "description": "The Id of the Secret Access Request.",
          "type": "integer",
          "format": "int32"
        },
        "secretId": {
          "description": "The Id of the Secret associated to the access request.",
          "type": "integer",
          "format": "int32"
        },
        "secretName": {
          "description": "The Name of the Secret associated to the access request.",
          "type": "string"
        },
        "startDate": {
          "description": "The Start Date of the request.",
          "type": "string",
          "format": "date-time"
        },
        "status": {
          "$ref": "#/$defs/AccessRequestState"
        },
        "statusDescription": {
          "description": "The Status Description of the request",
          "type": "string"
        },
        "ticketNumber": {
          "description": "The Ticket Number of the request",
          "type": "string"
        },
        "ticketSystemId": {
          "description": "The Ticket System Id of the request",
          "type": [
            "integer",
            "null"
          ],
          "format": "int32"
        }
      },
      "type": "object"
    },
    "Severity": {
      "description": "Error severity level",
      "properties": {},
      "type": "string",
      "enum": [
        "None",
        "Retry",
        "Warn",
        "Critical",
        "Fatal"
      ]
    },
    "Sort": {
      "description": "Sort options. Multiple sort options can be provided in the query string.",
      "required": [
        "name",
        "direction"
      ],
      "properties": {
        "direction": {
          "$ref": "#/$defs/SortDirection"
        },
        "name": {
          "description": "Sort field name",
          "type": "string"
        },
        "priority": {
          "description": "Priority index. Sorts with lower values are executed earlier",
          "type": "integer",
          "format": "int32"
        }
      },
      "type": "object"
    },
    "SortDirection": {
      "description": "Sort direction",
      "properties": {},
      "type": "string",
      "enum": [
        "None",
        "Asc",
        "Desc"
      ]
    }
  }
}