Delinea SecretTemplatePermissions API

openapi: 3.0.0
info:
  title: Secret Server Rest Activations SecretTemplatePermissions 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: SecretTemplatePermissions
  description: Secret Template Permissions
paths:
  /v1/secret-template-permissions/grouped:
    get:
      tags:
      - SecretTemplatePermissions
      summary: Get Secret Template Permissions
      description: Get Secret Template Permissions
      operationId: SecretTemplatePermissionsService_SearchTemplatePermissions
      parameters:
      - name: filter.groupId
        in: query
        description: Will only return permissions that apply to this group
        required: false
        x-nullable: true
        schema:
          type: integer
          format: int32
      - name: filter.templateId
        in: query
        description: Will only return permissions that apply to this template
        required: false
        x-nullable: true
        schema:
          type: integer
          format: int32
      - name: filter.userId
        in: query
        description: Will only return permissions that apply to this user
        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: Secret Template Permissions
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PagingOfSecretTemplateGroupedPermissionSummary'
        '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-template-permissions:
    get:
      tags:
      - SecretTemplatePermissions
      summary: Search Secret Template Permissions
      description: Search, filter, sort, and page secret template permissions
      operationId: SecretTemplatePermissionsService_Search
      parameters:
      - name: filter.domainId
        in: query
        description: DomainId
        required: false
        x-nullable: true
        schema:
          type: integer
          format: int32
      - name: filter.groupId
        in: query
        description: Group Id
        required: false
        schema:
          type: integer
          format: int32
      - name: filter.searchText
        in: query
        description: Search text
        required: false
        schema:
          type: string
      - name: filter.secretTypeId
        in: query
        description: Secret type (template) Id
        required: false
        x-nullable: true
        schema:
          type: integer
          format: int32
      - name: filter.userSearchText
        in: query
        description: User search text
        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 template permission search result object
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PagingOfSecretTemplateGroupSummary'
        '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:
      - SecretTemplatePermissions
      summary: Update Secret Templates Permissions
      description: Change permissions
      operationId: SecretTemplatePermissionsService_Update
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/SecretTemplatePermissionsUpdateArgs'
        description: Secret permission creation options
      responses:
        '200':
          description: Secret permission object
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SecretTemplatePermissionModel'
        '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-template-permissions/roles:
    get:
      tags:
      - SecretTemplatePermissions
      summary: Get Secret Template Permission Roles
      description: Get Secret Template Permission Roles
      operationId: SecretTemplatePermissionsService_GetTemplatePermissionRoles
      responses:
        '200':
          description: Secret Template Permission Role
          content:
            application/json:
              schema:
                description: Secret Template Permission Role
                items:
                  $ref: '#/components/schemas/SecretTemplatePermissionRole'
                type: array
        '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-template-permissions/{secretTypeId}:
    put:
      tags:
      - SecretTemplatePermissions
      summary: Update Secret Template Type Permissions
      description: Update all the permissions for a single Secret template
      operationId: SecretTemplatePermissionsService_UpdateTemplatePermissions
      parameters:
      - name: secretTypeId
        in: path
        description: secretTypeId
        required: true
        schema:
          type: integer
          format: int32
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/SecretTemplateTypePermissionsUpdateArgs'
        description: Secret permission update options
      responses:
        '200':
          description: Update permissions status response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SecretTemplateTypePermissionsUpdateResponse'
        '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
    SecretTemplatePermissionAssignmentSummary:
      description: aaaa
      properties:
        directlyAssigned:
          description: When the group is a personal group this permission is directly assigned to that user.
          type: boolean
        groupId:
          description: Group ID assigned for this permission.  Either an actual group or personal group ID.
          type: integer
          format: int32
        groupName:
          description: The name of the group that is assigned
          type: string
        userDisplayName:
          description: The user display name, only populated when directly assigned
          type: string
        userId:
          description: The user ID, only populated when directly assigned
          type: integer
          format: int32
          nullable: true
      type: object
    SortDirection:
      description: Sort direction
      properties: {}
      type: string
      enum:
      - None
      - Asc
      - Desc
    Severity:
      description: Error severity level
      properties: {}
      type: string
      enum:
      - None
      - Retry
      - Warn
      - Critical
      - Fatal
    SecretTemplateGroupedPermissionSummary:
      description: Secret templates with assigned permissions
      properties:
        assignments:
          description: All of the specific users and groups assigned to this template
          items:
            $ref: '#/components/schemas/SecretTemplatePermissionAssignmentSummary'
          type: array
        roleId:
          description: The ID of the role assigned
          type: integer
          format: int32
        roleName:
          description: The name of the role assigned
          type: string
        secretTypeId:
          description: Secret templates with assigned permissions. NULL if all templates
          type: integer
          format: int32
          nullable: true
        secretTypeName:
          description: Secret Template Name
          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
    SecretTemplateTypePermissionsUpdateResponse:
      description: SecretTemplateTypePermissionsUpdateResponse
      properties:
        success:
          description: Success
          type: boolean
      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
    PagingOfSecretTemplateGroupSummary:
      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/SecretTemplateGroupSummary'
          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
    SecretTemplateTypePermissionsUpdateGroup:
      description: Permissions
      properties:
        groupId:
          description: GroupId
          type: integer
          format: int32
        roleId:
          description: RoleId
          type: integer
          format: int32
      type: object
    SecretTemplateTypePermissionsUpdateModel:
      description: Data
      properties:
        permissions:
          description: Permissions
          items:
            $ref: '#/components/schemas/SecretTemplateTypePermissionsUpdateGroup'
          type: array
      type: object
    SecretTemplatePermissionsUpdateArgs:
      description: SecretTemplatePermissionsUpdateArgs
      properties:
        groupId:
          description: GroupId
          type: integer
          format: int32
        permissions:
          description: Permissions
          items:
            $ref: '#/components/schemas/PermissionModel'
          type: array
      type: object
    SecretTemplateGroupSummary:
      description: Secret Template Group Summary
      properties:
        displayName:
          description: Display Name
          type: string
        displayNameWithDomain:
          description: Display Name with Domain
          type: string
        domainName:
          description: Domain Name
          type: string
        groupId:
          description: Group Id
          type: integer
          format: int32
        isPersonal:
          description: Is Personal
          type: boolean
        secretTypeAccessRoleId:
          description: Secret Type Access Role Id
          type: integer
          format: int32
        secretTypeId:
          description: Secret Type Id
          type: integer
          format: int32
        secretTypeName:
          description: Secret Type Name
          type: string
        userId:
          description: If it is a personal group, the user id of the user
          type: integer
          format: int32
          nullable: true
      type: object
    AuthenticationFailedResponse:
      description: Response object for authentication failures
      required:
      - message
      properties:
        message:
          description: Error message
          type: string
      type: object
    PagingOfSecretTemplateGroupedPermissionSummary:
      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/SecretTemplateGroupedPermissionSummary'
          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
    SecretTemplatePermissionRole:
      description: SecretTemplatePermissionRole[]
      properties:
        roleId:
          description: The ID of the role
          type: integer
          format: int32
        roleName:
          description: The name of the role
          type: string
      type: object
    PermissionModel:
      description: Permissions
      properties:
        roleId:
          description: RoleId
          type: integer
          format: int32
        secretTypeId:
          description: SecretTypeId
          type: integer
          format: int32
          nullable: true
      type: object
    SecretTemplateTypePermissionsUpdateArgs:
      description: SecretTemplateTypePermissionsUpdateArgs
      properties:
        data:
          $ref: '#/components/schemas/SecretTemplateTypePermissionsUpdateModel'
      type: object
    SecretTemplatePermissionModel:
      description: Secret template
      properties:
        id:
          description: Secret template ID
          type: integer
          format: int32
          nullable: true
        name:
          description: Secret template name
          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