openapi: 3.0.0
info:
  title: Secret Server Rest Activations AppClients 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: AppClients
  description: View and maintain app clients
paths:
  /v1/app-clients/{id}:
    get:
      tags:
      - AppClients
      summary: Get App Client
      description: Get a single app client by ID
      operationId: AppClientsService_GetClient
      parameters:
      - name: includeInactive
        in: query
        description: Whether to include inactive app clients
        required: false
        schema:
          type: boolean
      - name: id
        in: path
        description: App client ID
        required: true
        schema:
          type: integer
          format: int32
      responses:
        '200':
          description: App client object
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AppClientModel'
        '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:
      - AppClients
      summary: Update App Client
      description: Update a single app client by ID
      operationId: AppClientsService_UpdateClient
      parameters:
      - name: id
        in: path
        description: App client ID
        required: true
        schema:
          type: integer
          format: int32
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/AppClientUpdateArgs'
        description: App client update options
      responses:
        '200':
          description: App client object
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AppClientModel'
        '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
    delete:
      tags:
      - AppClients
      summary: Delete App Client
      description: Delete an app client by ID
      operationId: AppClientsService_DeleteClient
      parameters:
      - name: id
        in: path
        description: App client ID
        required: true
        schema:
          type: integer
          format: int32
      responses:
        '200':
          description: Object deletion result
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DeletedModel'
        '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/app-clients/stub:
    get:
      tags:
      - AppClients
      summary: Get App Client Stub
      description: Return the default values for a new app client
      operationId: AppClientsService_Stub
      responses:
        '200':
          description: App client object
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AppClientModel'
        '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/app-clients:
    post:
      tags:
      - AppClients
      summary: Create App Client
      description: Create a new app client
      operationId: AppClientsService_CreateClient
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/AppClientCreateArgs'
        description: App client creation options
      responses:
        '200':
          description: App client object
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AppClientModel'
        '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:
    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
    DeletedModel:
      description: Information about an object that was deleted
      properties:
        id:
          description: ID of the deleted object
          type: integer
          format: int32
        objectType:
          description: Type of the deleted object
          type: string
        responseCodes:
          description: List of response codes from the delete operation
          items:
            type: string
          type: array
      type: object
    AppClientUpdateArgs:
      description: App client update options
      required:
      - id
      - redirectUri
      properties:
        id:
          description: App client ID. Must match ID in path
          type: integer
          format: int32
        redirectUri:
          description: Authorized redirect URI for this app client
          type: string
          maxLength: 1000
      type: object
    AppClientCreateArgs:
      description: App client creation options
      properties:
        redirectUri:
          description: Authorized redirect URI for this app client
          type: string
      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
    AuthenticationFailedResponse:
      description: Response object for authentication failures
      required:
      - message
      properties:
        message:
          description: Error message
          type: string
      type: object
    AppClientModel:
      description: App client
      properties:
        clientId:
          description: App client unique identifier
          type: string
          format: uuid
        id:
          description: App client ID
          type: integer
          format: int32
        redirectUri:
          description: Authorized redirect URI for this app client
          type: string
      type: object
  securitySchemes:
    BearerToken:
      type: apiKey
      description: 'Perform a POST request to `/oauth2/token`. It should include three form data parameters - `username`, `password`, and `grant_type`.The `grant_type` parameter should always have the value `password`.The access token returned should be included in the header of subsequent requests, like ''Authorization: Bearer <em>token</em>''. The token remains valid for a time period returned in the ''expires_in'' property (in seconds). For details, see the <a href="../OAuth/">token request documentation</a>.'
      name: Authorization
      in: header