Delinea Groups API

openapi: 3.0.0
info:
  title: Secret Server Rest Activations Groups 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: Groups
  description: View and maintain user security groups
paths:
  /v1/groups/{id}:
    get:
      tags:
      - Groups
      summary: Get Group
      description: Get a single group by ID
      operationId: GroupsService_Get
      parameters:
      - name: id
        in: path
        description: Group ID
        required: true
        schema:
          type: integer
          format: int32
      responses:
        '200':
          description: Group object
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GroupModel'
        '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:
      - Groups
      summary: Update Group
      description: Update a single group by ID
      operationId: GroupsService_Update
      parameters:
      - name: id
        in: path
        description: Group ID
        required: true
        schema:
          type: integer
          format: int32
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/GroupUpdateArgs'
        description: Group update options
      responses:
        '200':
          description: Group object
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GroupModel'
        '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:
      - Groups
      summary: Delete Group
      description: Delete a group by ID
      operationId: GroupsService_Delete
      parameters:
      - name: id
        in: path
        description: Group 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/groups/{id}/users/{userId}:
    get:
      tags:
      - Groups
      summary: Get User In Group
      description: Get a user in a group
      operationId: GroupsService_GetGroupUser
      parameters:
      - name: id
        in: path
        description: Group ID
        required: true
        schema:
          type: integer
          format: int32
      - name: userId
        in: path
        description: User ID
        required: true
        schema:
          type: integer
          format: int32
      responses:
        '200':
          description: User group membership object
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GroupUserModel'
        '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:
      - Groups
      summary: Remove User From Group
      description: Remove a user from a group
      operationId: GroupsService_RemoveUserFromGroup
      parameters:
      - name: id
        in: path
        description: Group ID
        required: true
        schema:
          type: integer
          format: int32
      - name: userId
        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
  /v1/groups/{id}/roles:
    get:
      tags:
      - Groups
      summary: Gets roles for group
      description: Gets roles for group
      operationId: GroupsService_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
    post:
      tags:
      - Groups
      summary: Add roles to existing group
      description: Add roles to existing group
      operationId: GroupsService_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:
      - Groups
      summary: Remove roles from existing group
      description: Remove roles from existing group
      operationId: GroupsService_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/groups:
    get:
      tags:
      - Groups
      summary: Search Groups
      description: Search, filter, sort, and page groups
      operationId: GroupsService_Search
      parameters:
      - name: filter.domainId
        in: query
        description: Active Directory domain ID
        required: false
        x-nullable: true
        schema:
          type: integer
          format: int32
      - name: filter.excludeInboxRuleIdSubscribers
        in: query
        description: Do not include any groups already subscribed this inbox notification rule
        required: false
        x-nullable: true
        schema:
          type: integer
          format: int32
      - name: filter.includeInactive
        in: query
        description: Whether to include inactive groups in the results
        required: false
        schema:
          type: boolean
      - name: filter.limitToViewableGroups
        in: query
        description: Limit groups to groups that current user can view details of
        required: false
        schema:
          type: boolean
      - name: filter.platformOnly
        in: query
        description: Limit groups to only Platform groups
        required: false
        x-nullable: true
        schema:
          type: boolean
      - name: filter.searchText
        in: query
        description: 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: Group search result object
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PagingOfGroupSummary'
        '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:
      - Groups
      summary: Create Group
      description: Create a new group
      operationId: GroupsService_Create
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/GroupCreateArgs'
        description: Group creation options
      responses:
        '200':
          description: Group object
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GroupModel'
        '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/groups/lookup:
    get:
      tags:
      - Groups
      summary: Lookup Groups
      description: Search, filter, sort, and page groups, returning only group ID and name
      operationId: GroupsService_Lookup
      parameters:
      - name: filter.domainId
        in: query
        description: Active Directory domain ID
        required: false
        x-nullable: true
        schema:
          type: integer
          format: int32
      - name: filter.excludeInboxRuleIdSubscribers
        in: query
        description: Do not include any groups already subscribed this inbox notification rule
        required: false
        x-nullable: true
        schema:
          type: integer
          format: int32
      - name: filter.includeInactive
        in: query
        description: Whether to include inactive groups in the results
        required: false
        schema:
          type: boolean
      - name: filter.limitToViewableGroups
        in: query
        description: Limit groups to groups that current user can view details of
        required: false
        schema:
          type: boolean
      - name: filter.platformOnly
        in: query
        description: Limit groups to only Platform groups
        required: false
        x-nullable: true
        schema:
          type: boolean
      - name: filter.searchText
        in: query
        description: 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: Group search result object
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PagingOfGroupLookup'
        '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/groups/stub:
    get:
      tags:
      - Groups
      summary: Get Group Stub
      description: Return the default values for a new group
      operationId: GroupsService_Stub
      responses:
        '200':
          description: Group object
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GroupModel'
        '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/groups/{id}/users:
    get:
      tags:
      - Groups
      summary: Get Group Membership
      description: Get group membership will return all of the users that are assigned as members of the group
      operationId: GroupsService_GetGroupMembership
      parameters:
      - name: id
        in: path
        description: Group ID
        required: true
        schema:
          type: integer
          format: int32
      - name: filter.includeInactiveUsersForGroup
        in: query
        description: Whether to include inactive users in the results
        required: false
        schema:
          type: boolean
      - name: filter.userDomainId
        in: query
        description: Filter only users in a specific domain
        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: 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
    post:
      tags:
      - Groups
      summary: Add User To Group
      description: Add a user to a group
      operationId: GroupsService_AddUserToGroup
      parameters:
      - name: id
        in: path
        description: Group ID
        required: true
        schema:
          type: integer
          format: int32
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/GroupUserCreateArgs'
        description: Group user add options
      responses:
        '200':
          description: User group membership object
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GroupUserModel'
        '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:
      - Groups
      summary: Patch Group Membership
      description: Update group memberships by sending a list of add and remove IDs
      operationId: GroupsService_PatchGroupMembership
      parameters:
      - name: id
        in: path
        description: Group ID
        required: true
        schema:
          type: integer
          format: int32
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/GroupMembershipPatchModel'
        description: Group update options
      responses:
        '200':
          description: Group model
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GroupMembershipPatchResult'
        '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/groups/audit:
    get:
      tags:
      - Groups
      summary: Get group audits
      description: Audit records for group assignments
      operationId: GroupsService_GetAuditGroupAssignments
      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
      responses:
        '200':
          description: Audit records for group assignments
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PagingOfAdminAuditItem'
        '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/groups/{id}/users-lookup:
    get:
      tags:
      - Groups
      summary: Get Group Users for display
      description: Get Group Users for display by group id
      operationId: GroupsService_GetGroupUsersLookup
      parameters:
      - name: id
        in: path
        description: Group ID
        required: true
        schema:
          type: integer
          format: int32
      responses:
        '200':
          description: GroupUsersLookupViewModel object
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GroupUsersLookupViewModel'
        '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/groups/{id}/users/search:
    get:
      tags:
      - Groups
      summary: Group members search
      description: Group members search will return all of the users that are assigned and/or unassigned as members of the group.
      operationId: GroupsService_GroupMemberSearch
      parameters:
      - name: id
        in: path
        description: Group ID
        required: true
        schema:
          type: integer
          format: int32
      - name: filter.assigned
        in: query
        description: Include or exclude Users assigned to the specified Group; include both assigned and unassigned if null.
        required: false
        x-nullable: true
        schema:
          type: boolean
      - name: filter.domainId
        in: query
        description: Include only Users in this domain. Pass -1 to return local accounts.  Null or empty will not filter by domain.
        required: false
        x-nullable: true
        schema:
          type: integer
          format: int32
      - name: filter.groupId
        in: query
        description: Include/exclude members of this Group depending on the value of the Assigned parameter.
        required: false
        schema:
          type: integer
          format: int32
      - name: filter.searchTerm
        in: query
        description: Include only Users whose display name contains the search term.
        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: Group membership results
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GroupMembersSearchResult'
        '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/groups/platform/{adGuid}:
    get:
      tags:
      - Groups
      summary: Get Group by domain identifier
      description: Get a single group by AD Guid
      operationId: GroupsService_GetGroupByPlatformIdentifer
      parameters:
      - name: adGuid
        in: path
        description: Group ID
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Group object
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GroupModel'
        '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':
          descri

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