Delinea Users API

openapi: 3.0.0
info:
  title: Secret Server Rest Activations Users 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: Users
  description: View and maintain users
paths:
  /v1/users/{id}:
    get:
      tags:
      - Users
      summary: Get User
      description: Get a single user by ID
      operationId: UsersService_Get
      parameters:
      - name: includeInactive
        in: query
        description: Whether to include inactive users in the results
        required: false
        schema:
          type: boolean
      - name: id
        in: path
        description: User ID
        required: true
        schema:
          type: integer
          format: int32
      responses:
        '200':
          description: User object
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UserModel'
        '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:
      - Users
      summary: Update User
      description: Update a single user by ID
      operationId: UsersService_UpdateUser
      parameters:
      - name: id
        in: path
        description: User ID
        required: true
        schema:
          type: integer
          format: int32
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UserUpdateArgs'
        description: User update options
      responses:
        '200':
          description: User object
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UserModel'
        '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:
      - Users
      summary: Delete User
      description: Delete a user by ID
      operationId: UsersService_Delete
      parameters:
      - name: id
        in: path
        description: User 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
    patch:
      tags:
      - Users
      summary: Update included properties for user by Id
      description: Update included properties for user by Id
      operationId: UsersService_PatchUser
      parameters:
      - name: id
        in: path
        description: id
        required: true
        schema:
          type: integer
          format: int32
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PatchUserModel'
        description: patchModel
      responses:
        '200':
          description: User Configuration
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UserModel'
        '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/users/{id}/owners/{ownerId}:
    get:
      tags:
      - Users
      summary: Get User Owner
      description: Get a single owner for a user
      operationId: UsersService_GetUserOwner
      parameters:
      - name: id
        in: path
        description: User ID
        required: true
        schema:
          type: integer
          format: int32
      - name: ownerId
        in: path
        description: Owner ID
        required: true
        schema:
          type: integer
          format: int32
      responses:
        '200':
          description: User owner object
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UserOwnerModel'
        '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:
      - Users
      summary: Remove User Owner
      description: Remove an owner from a single user
      operationId: UsersService_DeleteUserOwner
      parameters:
      - name: id
        in: path
        description: User ID
        required: true
        schema:
          type: integer
          format: int32
      - name: ownerId
        in: path
        description: Owner ID is the unique sequence for this specific owner.  This is returned as ID on UserOwnerModel
        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/users/{id}/roles:
    get:
      tags:
      - Users
      summary: Gets roles for user
      description: Gets roles for user
      operationId: UsersService_GetRoles
      parameters:
      - 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
      - name: id
        in: path
        description: id
        required: true
        schema:
          type: integer
          format: int32
      responses:
        '200':
          description: Success / Fail
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PagingOfRoleSummary'
        '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:
      - Users
      summary: Update all roles on user
      description: Update all roles on user
      operationId: UsersService_UpdateUserRoles
      parameters:
      - name: id
        in: path
        description: id
        required: true
        schema:
          type: integer
          format: int32
      requestBody:
        $ref: '#/components/requestBodies/RoleAssignments'
      responses:
        '200':
          description: Success / Fail
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RoleChangeStatusModel'
        '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:
      - Users
      summary: Add roles to existing user
      description: Add roles to existing user
      operationId: UsersService_CreateUserRoles
      parameters:
      - name: id
        in: path
        description: id
        required: true
        schema:
          type: integer
          format: int32
      requestBody:
        $ref: '#/components/requestBodies/RoleAssignments'
      responses:
        '200':
          description: Success / Fail
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RoleChangeStatusModel'
        '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:
      - Users
      summary: Remove roles from existing user
      description: Remove roles from existing user
      operationId: UsersService_DeleteUserRoles
      parameters:
      - name: id
        in: path
        description: id
        required: true
        schema:
          type: integer
          format: int32
      requestBody:
        $ref: '#/components/requestBodies/RoleRemovals'
      responses:
        '200':
          description: Success / Fail
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RoleChangeStatusModel'
        '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/users/{id}/groups:
    get:
      tags:
      - Users
      summary: Get User Groups
      description: Get the groups for a user by ID
      operationId: UsersService_GetUserGroups
      parameters:
      - name: id
        in: path
        description: User 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: Group membership results
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PagingOfGroupUserSummary'
        '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:
      - Users
      summary: Update all groups on user
      description: Update all groups on user
      operationId: UsersService_UpdateUserGroups
      parameters:
      - name: id
        in: path
        description: id
        required: true
        schema:
          type: integer
          format: int32
      requestBody:
        $ref: '#/components/requestBodies/GroupAssignments'
      responses:
        '200':
          description: Success / Fail
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GroupChangeStatusModel'
        '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:
      - Users
      summary: Add groups to existing user
      description: Add groups to existing user
      operationId: UsersService_AddUserToGroups
      parameters:
      - name: id
        in: path
        description: id
        required: true
        schema:
          type: integer
          format: int32
      requestBody:
        $ref: '#/components/requestBodies/GroupAssignments'
      responses:
        '200':
          description: Success / Fail
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GroupChangeStatusModel'
        '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:
      - Users
      summary: Remove groups from existing user
      description: Remove groups from existing user
      operationId: UsersService_RemoveUserGroups
      parameters:
      - name: groupIds
        in: query
        description: groupIds
        required: false
        explode: true
        schema:
          type: array
          items:
            type: integer
      - name: id
        in: path
        description: id
        required: true
        schema:
          type: integer
          format: int32
      responses:
        '200':
          description: Success / Fail
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GroupChangeStatusModel'
        '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/users:
    get:
      tags:
      - Users
      summary: Search Users
      description: Search, filter, sort, and page users
      operationId: UsersService_SearchUsers
      parameters:
      - name: filter.domainId
        in: query
        description: If not null, filters users by Active Directory domain.
        required: false
        x-nullable: true
        schema:
          type: integer
          format: int32
      - name: filter.excludeInboxRuleIdSubscribers
        in: query
        description: When set all subscribers not subscribed directly to this inbox notification rule will be excluded.
        required: false
        x-nullable: true
        schema:
          type: integer
          format: int32
      - name: filter.includeInactive
        in: query
        description: Whether to include inactive users in the results.
        required: false
        schema:
          type: boolean
      - name: filter.searchFields
        in: query
        description: User fields to search.
        required: false
        explode: true
        schema:
          type: array
          items:
            type: string
      - name: filter.searchText
        in: query
        description: The text to match in the username, display name, or email address.
        required: false
        schema:
          type: string
      - name: filter.userIds
        in: query
        description: User Ids to search.
        required: false
        explode: true
        schema:
          type: array
          items:
            type: integer
      - 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: User search result object
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PagingOfUserSummary'
        '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:
      - Users
      summary: Create User
      description: Create a new user
      operationId: UsersService_CreateUser
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UserCreateArgs'
        description: User creation options
      responses:
        '200':
          description: User object
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UserModel'
        '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/users/current-summary:
    get:
      tags:
      - Users
      summary: Current User Summary
      description: Gets the current user summary
      operationId: UsersService_GetCurrentUserSummary
      responses:
        '200':
          description: Current user summary result object
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CurrentUserSummaryModel'
        '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/users/current:
    get:
      tags:
      - Users
      summary: Current User
      description: Gets the current user
      operationId: UsersService_GetCurrentUser
      responses:
        '200':
          description: Current user result object
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CurrentUserModel'
        '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/users/lookup:
    get:
      tags:
      - Users
      summary: Lookup Users
      description: Search, filter, sort, and page users, returning only user ID and name
      operationId: UsersService_Lookup
      parameters:
      - name: filter.domainId
        in: query
        description: If not null, filters users by Active Directory domain.
        required: false
        x-nullable: true
        schema:
          type: integer
          format: int32
      - name: filter.excludeInboxRuleIdSubscribers
        in: query
        description: When set all subscribers not subscribed directly to this inbox notification rule will be excluded.
        required: false
        x-nullable: true
        schema:
          type: integer
          format: int32
      - name: filter.includeInactive
        in: query
        description: Whether to include inactive users in the results.
        required: false
        schema:
          type: boolean
      - name: filter.searchFields
        in: query
        description: User fields to search.
        required: false
        explode: true
        schema:
          type: array
          items:
            type: string
      - name: filter.searchText
        in: query
        description: The text to match in the username, display name, or email address.
        required: false
        schema:
          type: string
      - name: filter.userIds
        in: query
        description: User Ids to search.
        required: false
        explode: true
        schema:
          type: array
          items:
            type: integer
      - 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: User search result object
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PagingOfUserLookup'
        '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/users/stub:
    get:
      tags:
      - Users
      summary: Get User Stub
      description: Return the default values for a new user
      operationId: UsersService_Stub
      responses:
        '200':
          description: Default User
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UserModel'
        '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/users/platform/{platformUserId}:
    get:
      tags:
      - Users
      summary: Get User by External Platform User ID
      description: Get a single user by the External Platform User ID
      operationId: UsersService_GetUserByPlatformId
      parameters:
      - name: includeInactive
        in: query
        description: Whether to include inactive users in the results
        required: false
        schema:
          type: boolean
      - name: platformUserId
        in: path
        description: User Platform Guid
        required: true
        schema:
          type: string
      responses:
        '200':
          description: User object
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UserModel'
        '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/users/public-ssh-keys:
    get:
      tags:
      - Users
      summary: Get User Public Ssh Keys
      description: Get the public ssh keys for a user by ID
      operationId: UsersService_GetUserPublicSshKeys
      parameters:
      - name: filter.includeExpired
     

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