Delinea SecretAccessRequests API

openapi: 3.0.0
info:
  title: Secret Server Rest Activations SecretAccessRequests API
  description: REST API documentation for Secret Server. This document describes how to use the REST API. All requests require an authentication token; please see the <a href="../OAuth/">authentication document</a> for more information. The <a href="swagger.json">Swagger specification</a> for this API is also available.
  termsOfService: https://delinea.com/eula
  contact:
    name: Support
    url: https://delinea.com
  version: 11.7.2
servers:
- url: /SecretServer/api
security:
- BearerToken: []
tags:
- name: SecretAccessRequests
  description: SecretAccessRequestsController
paths:
  /v1/secret-access-requests:
    get:
      tags:
      - SecretAccessRequests
      summary: Search Secret Access Requests by Status for Current User.
      description: Search Secret Access Requests by Status for Current User.
      operationId: SecretAccessRequestsService_SearchRequests
      parameters:
      - name: filter.isMyRequest
        in: query
        description: IsMyRequest
        required: false
        schema:
          type: boolean
      - name: filter.status
        in: query
        description: Status
        required: false
        schema:
          type: string
      - name: skip
        in: query
        description: Number of records to skip before taking results
        required: false
        schema:
          type: integer
          format: int32
      - name: sortBy[0].direction
        in: query
        description: Sort direction
        required: false
        schema:
          type: string
      - name: sortBy[0].name
        in: query
        description: Sort field name
        required: false
        schema:
          type: string
      - name: sortBy[0].priority
        in: query
        description: Priority index. Sorts with lower values are executed earlier
        required: false
        schema:
          type: integer
          format: int32
      - name: take
        in: query
        description: Maximum number of records to include in results
        required: false
        schema:
          type: integer
          format: int32
      responses:
        '200':
          description: Secret Access Model
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PagingOfSecretAccessModel'
        '400':
          description: Bad request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BadRequestResponse'
        '403':
          description: Authentication failed
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AuthenticationFailedResponse'
        '500':
          description: Internal server error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InternalServerErrorResponse'
      deprecated: false
    put:
      tags:
      - SecretAccessRequests
      summary: Update a Secret Access Request
      description: Update the start date, end date, and status for a request.
      operationId: SecretAccessRequestsService_UpdateRequest
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/SecretAccessUpdateArgs'
        description: args
      responses:
        '200':
          description: Secret Access Action Result Model
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SecretAccessActionResultModel'
        '400':
          description: Bad request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BadRequestResponse'
        '403':
          description: Authentication failed
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AuthenticationFailedResponse'
        '500':
          description: Internal server error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InternalServerErrorResponse'
      deprecated: false
    post:
      tags:
      - SecretAccessRequests
      summary: Create a new Secret Access Request
      description: Create a new Secret Access Request
      operationId: SecretAccessRequestsService_CreateRequest
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/SecretAccessCreateArgs'
        description: args
      responses:
        '200':
          description: Secret Access Model
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SecretAccessModel'
        '400':
          description: Bad request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BadRequestResponse'
        '403':
          description: Authentication failed
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AuthenticationFailedResponse'
        '500':
          description: Internal server error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InternalServerErrorResponse'
      deprecated: false
  /v1/secret-access-requests/{id}/history:
    get:
      tags:
      - SecretAccessRequests
      summary: Get Secret access request history for the user that created the request.
      description: Get Secret access request history for the user that created the request.
      operationId: SecretAccessRequestsService_GetHistory
      parameters:
      - name: id
        in: path
        description: Secret Access Request Id
        required: true
        schema:
          type: integer
          format: int32
      - name: skip
        in: query
        description: Number of records to skip before taking results
        required: false
        schema:
          type: integer
          format: int32
      - name: sortBy[0].direction
        in: query
        description: Sort direction
        required: false
        schema:
          type: string
      - name: sortBy[0].name
        in: query
        description: Sort field name
        required: false
        schema:
          type: string
      - name: sortBy[0].priority
        in: query
        description: Priority index. Sorts with lower values are executed earlier
        required: false
        schema:
          type: integer
          format: int32
      - name: take
        in: query
        description: Maximum number of records to include in results
        required: false
        schema:
          type: integer
          format: int32
      responses:
        '200':
          description: Secret Access Request History Model
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PagingOfSecretAccessRequestHistoryModel'
        '400':
          description: Bad request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BadRequestResponse'
        '403':
          description: Authentication failed
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AuthenticationFailedResponse'
        '500':
          description: Internal server error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InternalServerErrorResponse'
      deprecated: false
  /v1/secret-access-requests/secrets/{id}:
    get:
      tags:
      - SecretAccessRequests
      summary: Get Secret Access Requests by Status for Current User.
      description: Get Secret Access Requests by Status for Current User.
      operationId: SecretAccessRequestsService_GetRequestsForSecret
      parameters:
      - name: id
        in: path
        description: Secret ID
        required: true
        schema:
          type: integer
          format: int32
      - name: skip
        in: query
        description: Number of records to skip before taking results
        required: false
        schema:
          type: integer
          format: int32
      - name: sortBy[0].direction
        in: query
        description: Sort direction
        required: false
        schema:
          type: string
      - name: sortBy[0].name
        in: query
        description: Sort field name
        required: false
        schema:
          type: string
      - name: sortBy[0].priority
        in: query
        description: Priority index. Sorts with lower values are executed earlier
        required: false
        schema:
          type: integer
          format: int32
      - name: take
        in: query
        description: Maximum number of records to include in results
        required: false
        schema:
          type: integer
          format: int32
      responses:
        '200':
          description: Secret Access Model
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PagingOfSecretAccessModel'
        '400':
          description: Bad request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BadRequestResponse'
        '403':
          description: Authentication failed
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AuthenticationFailedResponse'
        '500':
          description: Internal server error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InternalServerErrorResponse'
      deprecated: false
  /v1/secret-access-requests/{id}:
    get:
      tags:
      - SecretAccessRequests
      summary: Get Secret Access Request by ID
      description: Get Secret Access Request by ID
      operationId: SecretAccessRequestsService_GetRequest
      parameters:
      - name: id
        in: path
        description: Secret Access ID
        required: true
        schema:
          type: integer
          format: int32
      responses:
        '200':
          description: Secret Access Model
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SecretAccessModel'
        '400':
          description: Bad request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BadRequestResponse'
        '403':
          description: Authentication failed
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AuthenticationFailedResponse'
        '500':
          description: Internal server error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InternalServerErrorResponse'
      deprecated: false
  /v1/secret-access-requests/{id}/pending:
    get:
      tags:
      - SecretAccessRequests
      summary: Get Secret Access Request with Current and Eligible Reviewers by ID
      description: Get Secret Access Request by ID. Will also get a lists of current and eligible approvers if the request is in a Pending state
      operationId: SecretAccessRequestsService_GetPendingRequest
      parameters:
      - name: id
        in: path
        description: Secret Access ID
        required: true
        schema:
          type: integer
          format: int32
      responses:
        '200':
          description: Secret Access Model
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SecretAccessPendingRequestModel'
        '400':
          description: Bad request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BadRequestResponse'
        '403':
          description: Authentication failed
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AuthenticationFailedResponse'
        '500':
          description: Internal server error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InternalServerErrorResponse'
      deprecated: false
  /v1/secret-access-requests/secrets/{id}/options:
    get:
      tags:
      - SecretAccessRequests
      summary: Get Secret Access Options by Secret ID
      description: Get Secret Access Options by Secret ID
      operationId: SecretAccessRequestsService_GetOptionsBySecret
      parameters:
      - name: id
        in: path
        description: Secret ID
        required: true
        schema:
          type: integer
          format: int32
      responses:
        '200':
          description: Secret Access Request Options
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SecretAccessOptionsModel'
        '400':
          description: Bad request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BadRequestResponse'
        '403':
          description: Authentication failed
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AuthenticationFailedResponse'
        '500':
          description: Internal server error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InternalServerErrorResponse'
      deprecated: false
  /v1/secret-access-requests/secrets/{id}/view-comment:
    post:
      tags:
      - SecretAccessRequests
      summary: Create a new View Comment on a secret.
      description: Create a new View Comment on a secret.
      operationId: SecretAccessRequestsService_CreateViewComment
      parameters:
      - name: id
        in: path
        description: Secret ID
        required: true
        schema:
          type: integer
          format: int32
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/SecretAccessViewCommentArgs'
        description: args
      responses:
        '200':
          description: Success or Failure of the save.
          content:
            application/json:
              schema:
                description: Boolean
                type: boolean
        '400':
          description: Bad request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BadRequestResponse'
        '403':
          description: Authentication failed
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AuthenticationFailedResponse'
        '500':
          description: Internal server error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InternalServerErrorResponse'
      deprecated: false
components:
  schemas:
    Sort:
      description: Sort options. Multiple sort options can be provided in the query string.
      required:
      - name
      - direction
      properties:
        direction:
          $ref: '#/components/schemas/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
    SecretAccessReviewer:
      description: The Secret Access Approver model object
      properties:
        displayName:
          description: The Displayname of Id of the Secret Access Approver.
          type: string
        groupId:
          description: The Id of the approver group.
          type: integer
          format: int32
        isUser:
          description: Indication if the approver is an individual user.
          type: boolean
      type: object
    Severity:
      description: Error severity level
      properties: {}
      type: string
      enum:
      - None
      - Retry
      - Warn
      - Critical
      - Fatal
    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
          nullable: true
        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: '#/components/schemas/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
          format: int32
          nullable: true
      type: object
    PagingOfSecretAccessModel:
      description: Specify paging and sorting options for querying records and returning results
      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: '#/components/schemas/SecretAccessModel'
          type: array
        severity:
          $ref: '#/components/schemas/Severity'
        skip:
          description: Number of records to skip before taking results
          type: integer
          format: int32
        sortBy:
          description: List of sort properties
          items:
            $ref: '#/components/schemas/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
    InternalServerErrorResponse:
      description: Response object for internal server errors
      required:
      - message
      - exceptionMessage
      - exceptionType
      - stackTrace
      properties:
        message:
          description: Error message
          type: string
        exceptionMessage:
          description: Error message from exception
          type: string
        exceptionType:
          description: Exception type
          type: string
        stackTrace:
          description: Exception stack trace
          type: string
      type: object
    PagingOfSecretAccessRequestHistoryModel:
      description: Specify paging and sorting options for querying records and returning results
      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: '#/components/schemas/SecretAccessRequestHistoryModel'
          type: array
        severity:
          $ref: '#/components/schemas/Severity'
        skip:
          description: Number of records to skip before taking results
          type: integer
          format: int32
        sortBy:
          description: List of sort properties
          items:
            $ref: '#/components/schemas/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
    SecretAccessUpdateArgs:
      description: Secret Access Update paramaters
      properties:
        expirationDate:
          $ref: '#/components/schemas/DateTimeOffset'
        responseComment:
          description: Response Comment
          type: string
        secretAccessRequestId:
          description: Secret Access Request Id
          type: integer
          format: int32
        startDate:
          $ref: '#/components/schemas/DateTimeOffset'
        status:
          $ref: '#/components/schemas/SecretAccessModelStatus'
      type: object
    BadRequestResponse:
      description: Response object for invalid requests
      required:
      - message
      properties:
        message:
          description: Error message
          type: string
        messageDetail:
          description: Error message detail
          type: string
        errorCode:
          description: Error message code
          type: string
        modelState:
          description: An object describing validation errors
          type: object
      type: object
    SecretAccessCreateArgs:
      description: Secret Access Create paramaters
      required:
      - secretId
      properties:
        expirationDate:
          description: Expiration Date
          type: string
          format: date-time
        requestComment:
          description: Request Comment
          type: string
        secretId:
          description: Secret Id
          type: integer
          format: int32
        startDate:
          description: Start Date
          type: string
          format: date-time
        ticketNumber:
          description: Ticket Number
          type: string
        ticketSystemId:
          description: Ticket System ID
          type: integer
          format: int32
          nullable: true
      type: object
    SecretAccessModelStatus:
      description: 'New status for the request: Pending, Approved, Denied, Canceled'
      properties: {}
      type: string
      enum:
      - Pending
      - Approved
      - Denied
      - Canceled
    DateTimeOffset:
      description: Expiration Date
      properties:
        date:
          description: Date
          type: string
          format: date-time
        dateTime:
          description: DateTime
          type: string
          format: date-time
        day:
          description: Day
          type: integer
          format: int32
        dayOfWeek:
          $ref: '#/components/schemas/DayOfWeek'
        dayOfYear:
          description: DayOfYear
          type: integer
          format: int32
        hour:
          description: Hour
          type: integer
          format: int32
        localDateTime:
          description: LocalDateTime
          type: string
          format: date-time
        millisecond:
          description: Millisecond
          type: integer
          format: int32
        minute:
          description: Minute
          type: integer
          format: int32
        month:
          description: Month
          type: integer
          format: int32
        offset:
          description: Offset
          type: string
          format: time-span
        second:
          description: Second
          type: integer
          format: int32
        ticks:
          description: Ticks
          type: integer
          format: int64
        timeOfDay:
          description: TimeOfDay
          type: string
          format: time-span
        utcDateTime:
          description: UtcDateTime
          type: string
          format: date-time
        utcTicks:
          description: UtcTicks
          type: integer
          format: int64
        year:
          description: Year
          type: integer
          format: int32
      type: object
    SecretAccessPendingRequestModel:
      description: The Secret Access Pending 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
        currentStepApprovers:
          description: The List of approving reviewers for the current approval step.
          items:
            type: string
          type: array
        currentStepReviewers:
          description: The List of reviewers for the current approval step.
          items:
            $ref: '#/components/schemas/SecretAccessReviewer'
          type: array
        currentUserRestrictedFromReviewing:
          description: Indicating if current user is restricted from viewing the request
          type: boolean
          nullable: true
        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:
          description: The Status of the request
          type: string
        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
          format: int32
          nullable: true
      type: object
    SecretAccessActionResultModel:
      description: The Secret Access model object
      properties:
        accessRequestWorkflowMapId:
          description: The Id of the Access Request Workflow Map.
          type: integer
          format: int32
        actionResultMessage:
          description: ActionResultMessage
          type: string
        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
          nullable: true
        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 requ

# --- truncated at 32 KB (36 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/delinea/refs/heads/main/openapi/delinea-secretaccessrequests-api-openapi.yml