Docusign Group Users API

openapi: 3.2.0
info:
  title: Docusign Group Users API
  termsOfService: https://www.docusign.com/company/terms-and-conditions/web
  version: '1.0'
  description: 'Operations tagged GroupUsers across 2 of this provider''s published API definitions: docusign-openapi-original.yml, docusign-openapi.json. Each path carries the servers of the definition it was published in.'
servers:
- url: https://www.docusign.net/restapi
tags:
- name: Group Users
  description: The GroupUsers resource provides methods that allow you to manage the users in a group.
paths:
  /v2/accounts/{accountId}/groups/{groupId}/users:
    get:
      tags:
      - Group Users
      summary: Docusign Gets a list of users in a group
      description: Retrieves a list of users in a group.
      operationId: Groups_GetGroupUsers
      parameters:
      - name: accountId
        in: path
        description: The external account number (int) or account id GUID.
        required: true
        schema:
          type: string
      - name: groupId
        in: path
        description: The ID of the group being accessed.
        required: true
        schema:
          type: string
      - name: count
        in: query
        description: 'Number of records to return. The number must be greater than 1 and less than or equal to 100. '
        schema:
          type: string
      - name: start_position
        in: query
        description: Starting value for the list.
        schema:
          type: string
      responses:
        '200':
          description: Successful response.
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/usersResponse'
        '400':
          description: Error encountered.
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/errorDetails'
      deprecated: false
      x-ds-methodname: listGroupUsers
      x-ds-method: list
      x-ds-service: Groups
      x-ds-in-sdk: true
    put:
      tags:
      - Group Users
      summary: Docusign Adds one or more users to an existing group
      description: Adds one or more users to an existing group.
      operationId: Groups_PutGroupUsers
      parameters:
      - name: accountId
        in: path
        description: The external account number (int) or account id GUID.
        required: true
        schema:
          type: string
      - name: groupId
        in: path
        description: The ID of the group being accessed.
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/userInfoList'
          application/xml:
            schema:
              $ref: '#/components/schemas/userInfoList'
        required: false
      responses:
        '200':
          description: Successful response.
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/usersResponse'
        '400':
          description: Error encountered.
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/errorDetails'
      deprecated: false
      x-ds-methodname: updateGroupUsers
      x-ds-method: update
      x-ds-service: Groups
      x-ds-in-sdk: true
      x-codegen-request-body-name: userInfoList
    delete:
      tags:
      - Group Users
      summary: Docusign Deletes one or more users from a gro
      description: Deletes one or more users from a group.
      operationId: Groups_DeleteGroupUsers
      parameters:
      - name: accountId
        in: path
        description: The external account number (int) or account id GUID.
        required: true
        schema:
          type: string
      - name: groupId
        in: path
        description: The ID of the group being accessed.
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/userInfoList'
          application/xml:
            schema:
              $ref: '#/components/schemas/userInfoList'
        required: false
      responses:
        '200':
          description: Successful response.
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/usersResponse'
        '400':
          description: Error encountered.
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/errorDetails'
      deprecated: false
      x-ds-methodname: deleteGroupUsers
      x-ds-method: delete
      x-ds-service: Groups
      x-ds-in-sdk: true
      x-codegen-request-body-name: userInfoList
    servers:
    - url: https://www.docusign.net/restapi
  /v2.1/accounts/{accountId}/groups/{groupId}/users:
    parameters: []
    get:
      tags:
      - Group Users
      summary: Gets a list of users in a group
      description: Retrieves a list of users in a group.
      operationId: getV21AccountsByAccountIdGroupsByGroupIdUsers
      parameters:
      - name: accountId
        in: path
        description: The external account number (int) or account ID GUID.
        required: true
        schema:
          type: string
      - name: groupId
        in: path
        description: The ID of the group being accessed.
        required: true
        schema:
          type: string
      - name: count
        in: query
        description: 'The maximum number of results to return.


          Use `start_position` to specify the number of results to skip.


          Valid values: `1` to `100`<br>

          Default: `50`

          '
        required: false
        schema:
          type: string
      - name: start_position
        in: query
        description: 'The zero-based index of the

          result from which to start returning results.


          Use with `count` to limit the number

          of results.


          The default value is `0`.

          '
        required: false
        schema:
          type: string
      responses:
        '200':
          description: Successful response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/groupUsersResponse'
        '400':
          description: Error encountered.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/errorDetails_2'
      deprecated: false
      x-ds-methodname: listGroupUsers
      x-ds-method: list
      x-ds-service: Groups
      x-ds-in-sdk: true
      x-operation-id-source: normalized
      x-operation-id-original: Groups_GetGroupUsers
    put:
      tags:
      - Group Users
      summary: Adds one or more users to an existing group
      description: Adds one or more existing Docusign users to an existing group.
      operationId: putV21AccountsByAccountIdGroupsByGroupIdUsers
      parameters:
      - name: accountId
        in: path
        description: The external account number (int) or account ID GUID.
        required: true
        schema:
          type: string
      - name: groupId
        in: path
        description: The ID of the group being accessed.
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Successful response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/usersResponse_2'
        '400':
          description: Error encountered.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/errorDetails_2'
      deprecated: false
      x-ds-methodname: updateGroupUsers
      x-ds-method: update
      x-ds-service: Groups
      x-ds-in-sdk: true
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/userInfoList_2'
          application/xml:
            schema:
              $ref: '#/components/schemas/userInfoList_2'
      x-operation-id-source: normalized
      x-operation-id-original: Groups_PutGroupUsers
    delete:
      tags:
      - Group Users
      summary: Deletes one or more users from a group
      description: Deletes one or more users from a group. This request takes a `userInfoList` that contains the users that you want to delete.
      operationId: deleteV21AccountsByAccountIdGroupsByGroupIdUsers
      parameters:
      - name: accountId
        in: path
        description: The external account number (int) or account ID GUID.
        required: true
        schema:
          type: string
      - name: groupId
        in: path
        description: The ID of the group being accessed.
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Successful response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/usersResponse_2'
        '400':
          description: Error encountered.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/errorDetails_2'
      deprecated: false
      x-ds-methodname: deleteGroupUsers
      x-ds-method: delete
      x-ds-service: Groups
      x-ds-in-sdk: true
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/userInfoList_2'
          application/xml:
            schema:
              $ref: '#/components/schemas/userInfoList_2'
      x-operation-id-source: normalized
      x-operation-id-original: Groups_DeleteGroupUsers
    servers:
    - url: https://www.docusign.net/restapi
components:
  schemas:
    userInfo:
      type: object
      properties:
        activationAccessCode:
          type: string
          description: ''
        email:
          type: string
          description: ''
        errorDetails:
          $ref: '#/components/schemas/errorDetails'
        loginStatus:
          type: string
          description: ''
        sendActivationEmail:
          type: string
          description: ''
        uri:
          type: string
          description: ''
        userId:
          type: string
          description: 'The user ID of the user being accessed. Generally this is the user ID of the authenticated user, but if the authenticated user is an Admin on the account, this may be another user the Admin user is accessing. **Note**: For the [GET /v2/accounts/{accountId}/envelopes](https://developers.docusign.com/esign-rest-api/reference/Envelopes/Envelopes/listStatusChanges/#envelopesInformation) method, the `user_id` query parameter is not implemented and should not be used.'
        userName:
          type: string
          description: ''
        userStatus:
          type: string
          description: 'Status of the user''s account. One of:


            * ActivationRequired

            * ActivationSent

            * Active

            * Closed

            * Disabled

            '
        userType:
          type: string
          description: ''
      description: ''
      x-ds-definition-name: userInfo
      x-ms-summary: ''
    usersResponse:
      type: object
      properties:
        endPosition:
          type: string
          description: 'The last position in the result set. '
        nextUri:
          type: string
          description: 'The URI for the next chunk of records based on the search request. It is `null` if this is the last set of results for the search. '
        previousUri:
          type: string
          description: 'The URI for the prior chunk of records based on the search request. It is `null` if this is the first set of results for the search. '
        resultSetSize:
          type: string
          description: 'The number of results returned in this response. '
        startPosition:
          type: string
          description: Starting position of the current result set.
        totalSetSize:
          type: string
          description: The total number of items in the search's result set. It will always be greater than or equal to the value of the `resultSetSize` field.
        users:
          type: array
          description: ''
          items:
            $ref: '#/components/schemas/userInfo'
      description: ''
      x-ds-definition-name: usersResponse
      x-ms-summary: ''
    userInfoList:
      type: object
      properties:
        users:
          type: array
          description: ''
          items:
            $ref: '#/components/schemas/userInfo'
      description: ''
      x-ds-definition-name: userInfoList
      x-ms-summary: ''
    errorDetails:
      type: object
      properties:
        errorCode:
          type: string
          description: An error code associated with the error.
        message:
          type: string
          description: A short error message.
      description: This object describes errors that occur. It is only valid for responses, and ignored in requests.
      x-ds-definition-name: errorDetails
      x-ms-summary: This object describes errors that occur. It is only valid for responses, and ignored in requests.
    userInfo_2:
      type: object
      properties:
        accountId:
          description: The account ID associated with the envelope.
          type: string
        accountName:
          description: The name on the account.
          type: string
        activationAccessCode:
          description: Access code provided to the user to activate the account.
          type: string
        email:
          description: The user's email address.
          type: string
        errorDetails:
          $ref: '#/components/schemas/errorDetails_2'
          description: This object describes errors that occur. It is only valid for responses and ignored in requests.
        ipAddress:
          description: ''
          type: string
        loginStatus:
          description: When **true,** indicates that the user is logged in. This is a read-only property.
          type: string
        membershipId:
          description: The user's membership ID.
          type: string
        sendActivationEmail:
          description: This field is no longer supported for most accounts. To create an eSignature user without sending an activation email, use the Admin API by following [these steps](/docs/admin-api/how-to/create-active-user/).
          type: string
        uri:
          description: A URI containing the user ID.
          type: string
        userId:
          description: The ID of the user to access.
          type: string
        userName:
          description: The name of the user.
          type: string
        userStatus:
          description: 'Status of the user''s account. One of:


            - `ActivationRequired`

            - `ActivationSent`

            - `Active`

            - `Closed`

            - `Disabled`

            '
          type: string
        userType:
          description: The type of user, for example `CompanyUser`.
          type: string
      x-ds-definition-name: userInfo
      description: ''
      x-ms-summary: ''
    groupUserInfo:
      type: object
      properties:
        activationAccessCode:
          description: Access code provided to the user to activate the account.
          type: string
        email:
          description: ''
          type: string
        errorDetails:
          $ref: '#/components/schemas/errorDetails_2'
          description: This object describes errors that occur. It is only valid for responses and ignored in requests.
        loginStatus:
          description: Boolean value that indicates whether the user is currently logged in or not.
          type: string
        sendActivationEmail:
          description: This field is no longer supported for most accounts. To create an eSignature user without sending an activation email, use the Admin API by following [these steps](/docs/admin-api/how-to/create-active-user/).
          type: string
        uri:
          description: A URI containing the user ID.
          type: string
        userId:
          description: 'The ID of the user to access.


            **Note:** Users can only access their own information. A user, even one with Admin rights, cannot access another user''s settings.'
          type: string
        userName:
          description: The name of the user.
          type: string
        userStatus:
          description: 'Status of the user''s account. One of:


            - `ActivationRequired`

            - `ActivationSent`

            - `Active`

            - `Closed`

            - `Disabled`

            '
          type: string
        userType:
          description: The type of user, for example `CompanyUser`.
          type: string
      x-ds-definition-name: groupUserInfo
      description: ''
      x-ms-summary: ''
    errorDetails_2:
      description: This object describes errors that occur. It is only valid for responses and ignored in requests.
      type: object
      properties:
        errorCode:
          description: The code associated with the error condition.
          type: string
        message:
          description: A brief message describing the error condition.
          type: string
      x-ds-definition-name: errorDetails
      x-ms-summary: This object describes errors that occur. It is only valid for responses and ignored in requests.
    userInfoList_2:
      type: object
      properties:
        users:
          description: An array of `userInfo` objects containing information about the users in the group.
          type: array
          items:
            $ref: '#/components/schemas/userInfo_2'
      x-ds-definition-name: userInfoList
      description: ''
      x-ms-summary: ''
    groupUsersResponse:
      type: object
      properties:
        endPosition:
          description: 'The last index position in the result set. '
          type: string
        nextUri:
          description: 'The URI for the next chunk of records based on the search request. It is `null` if this is the last set of results for the search. '
          type: string
        previousUri:
          description: 'The URI for the prior chunk of records based on the search request. It is `null` if this is the first set of results for the search. '
          type: string
        resultSetSize:
          description: The number of results in this response. Because you can filter which entries are included in the response, this value is always less than or equal to the `totalSetSize`.
          type: string
        startPosition:
          description: The starting index position of the current result set.
          type: string
        totalSetSize:
          description: The total number of items in the result set. This value is always greater than or equal to the value of `resultSetSize`.
          type: string
        users:
          description: User management information.
          type: array
          items:
            $ref: '#/components/schemas/groupUserInfo'
      x-ds-definition-name: groupUsersResponse
      description: ''
      x-ms-summary: ''
    usersResponse_2:
      type: object
      properties:
        endPosition:
          description: 'The last index position in the result set. '
          type: string
        nextUri:
          description: 'The URI for the next chunk of records based on the search request. It is `null` if this is the last set of results for the search. '
          type: string
        previousUri:
          description: 'The URI for the prior chunk of records based on the search request. It is `null` if this is the first set of results for the search. '
          type: string
        resultSetSize:
          description: The number of results in this response. Because you can filter which entries are included in the response, this value is always less than or equal to the `totalSetSize`.
          type: string
        startPosition:
          description: The starting index position of the current result set.
          type: string
        totalSetSize:
          description: The total number of items in the result set. This value is always greater than or equal to the value of `resultSetSize`.
          type: string
        users:
          description: User management information.
          type: array
          items:
            $ref: '#/components/schemas/userInfo_2'
      x-ds-definition-name: usersResponse
      description: ''
      x-ms-summary: ''
x-refined-from:
- docusign-openapi-original.yml
- docusign-openapi.json
x-ds-categories:
- name: UserManagement
  summary: Methods to manage users in an account.
  description: Methods to manage users in an account.
- name: BulkOperations
  summary: Methods to import and export users and accounts.
  description: Methods to import and export users and accounts.
- name: IdentityProviders
  summary: Methods to get a list of identity providers.
  description: Methods to get a list of identity providers.
- name: ReservedDomains
  summary: Methods to get a list of reserved domains.
  description: Methods to get a list of reserved domains.
- name: Organization
  summary: Methods for working with organizations.
  description: Methods for working with organizations.
x-original-swagger-version: '2.0'