Delinea SdkClientAccounts API

openapi: 3.2.0
info:
  title: Secret Server Rest Activations SDK Client Accounts 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: SdkClientAccounts
  description: View and maintain SDK Client Accounts
paths:
  /v1/sdk-client-accounts:
    get:
      tags:
      - SdkClientAccounts
      summary: Search SDK Client Accounts
      description: Search, filter, sort, and page app SDK Client accounts
      operationId: SdkClientAccountsService_SearchClientAccounts
      parameters:
      - name: filter.operator
        in: query
        description: Operator
        required: false
        schema:
          type: string
      - name: filter.searchText
        in: query
        description: SearchText
        required: false
        schema:
          type: string
      - name: filter.userId
        in: query
        description: UserId
        required: false
        x-nullable: 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: SDK Client Account search result object
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PagingOfSdkClientAccountSummaryAndSdkClientAccountFilter'
        '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:
      - SdkClientAccounts
      summary: Create SDK Client Account
      description: Create a new SDK Client account
      operationId: SdkClientAccountsService_CreateClientAccount
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/SdkClientAccountCreateArgs'
        description: SDK Client Account creation options
      responses:
        '200':
          description: SdkClientAccountModel
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SdkClientAccountModel'
        '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/sdk-client-accounts/{id}:
    get:
      tags:
      - SdkClientAccounts
      summary: Get SDK Client Account
      description: Get a single SDK Client account by ID
      operationId: SdkClientAccountsService_Get
      parameters:
      - name: id
        in: path
        description: SDK Client Account Id
        required: true
        schema:
          type: integer
          format: int32
      responses:
        '200':
          description: SdkClientAccountModel
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SdkClientAccountModel'
        '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:
      - SdkClientAccounts
      summary: Update SDK Client Account
      description: Update a single SDK Client account by ID
      operationId: SdkClientAccountsService_UpdateClientAccount
      parameters:
      - name: id
        in: path
        description: SDK Client Account Id
        required: true
        schema:
          type: integer
          format: int32
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/SdkClientAccountUpdateArgs'
        description: SDK Client Account update options
      responses:
        '200':
          description: SdkClientAccountModel
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SdkClientAccountModel'
        '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/sdk-client-accounts/enabled:
    get:
      tags:
      - SdkClientAccounts
      summary: Get Current State
      description: Get the current state of SDK client account
      operationId: SdkClientAccountsService_GetEnabled
      responses:
        '200':
          description: bool
          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
    post:
      tags:
      - SdkClientAccounts
      summary: Toggle Current State
      description: Toggle the current state of SDK client account
      operationId: SdkClientAccountsService_ToggleEnabled
      responses:
        '200':
          description: bool
          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
  /v1/sdk-client-accounts/{id}/revoke:
    post:
      tags:
      - SdkClientAccounts
      summary: Revoke SDK Client Account
      description: Revoke a single SDK Client account by ID
      operationId: SdkClientAccountsService_Revoke
      parameters:
      - name: id
        in: path
        description: SDK Client Account Id
        required: true
        schema:
          type: integer
          format: int32
      responses:
        '200':
          description: bool
          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:
    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
    SdkClientAccountUpdateArgs:
      description: SdkClientAccountUpdateArgs
      required:
      - name
      properties:
        name:
          description: Name
          type: string
        userId:
          description: UserId
          type:
          - integer
          - 'null'
          format: int32
      type: object
    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
    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
    SdkClientAccountFilter:
      description: Additional query options
      properties:
        operator:
          $ref: '#/components/schemas/FilterOperator'
        searchText:
          description: SearchText
          type: string
        userId:
          description: UserId
          type:
          - integer
          - 'null'
          format: int32
      type: object
    SdkClientAccountModel:
      description: SdkClientAccountModel
      properties:
        clientId:
          description: ClientId
          type: string
          format: uuid
        clientSecret:
          description: ClientSecret
          type: string
        details:
          description: Details
          type: string
        id:
          description: Id
          type: integer
          format: int32
        ipAddress:
          description: IpAddress
          type: string
        name:
          description: Name
          type: string
        userDisplayName:
          description: UserDisplayName
          type: string
        userId:
          description: UserId
          type:
          - integer
          - 'null'
          format: int32
      type: object
    AuthenticationFailedResponse:
      description: Response object for authentication failures
      required:
      - message
      properties:
        message:
          description: Error message
          type: string
      type: object
    SdkClientAccountSummary:
      description: Query results
      properties:
        clientId:
          description: ClientId
          type: string
          format: uuid
        details:
          description: Details
          type: string
        id:
          description: Id
          type: integer
          format: int32
        ipAddress:
          description: IpAddress
          type: string
        name:
          description: Name
          type: string
        userDisplayName:
          description: UserDisplayName
          type: string
        userId:
          description: UserId
          type:
          - integer
          - 'null'
          format: int32
      type: object
    FilterOperator:
      description: Operator
      properties: {}
      type: string
      enum:
      - All
      - Include
      - Exclude
    Severity:
      description: Error severity level
      properties: {}
      type: string
      enum:
      - None
      - Retry
      - Warn
      - Critical
      - Fatal
    SdkClientAccountCreateArgs:
      description: SdkClientAccountCreateArgs
      required:
      - name
      - description
      - ruleName
      properties:
        clientId:
          description: ClientId
          type: string
          format: uuid
        description:
          description: Description
          type: string
        name:
          description: Name
          type: string
        onboardingKey:
          description: OnboardingKey
          type: string
        ruleName:
          description: RuleName
          type: string
      type: object
    SortDirection:
      description: Sort direction
      properties: {}
      type: string
      enum:
      - None
      - Asc
      - Desc
    PagingOfSdkClientAccountSummaryAndSdkClientAccountFilter:
      description: Specify filtering, paging, 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
        filter:
          $ref: '#/components/schemas/SdkClientAccountFilter'
        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/SdkClientAccountSummary'
          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
  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