Docusign UserCustomSettings API

openapi: 3.2.0
info:
  title: Docusign User Custom Settings API
  termsOfService: https://www.docusign.com/company/terms-and-conditions/web
  version: '1.0'
  description: 'Operations tagged UserCustomSettings 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: UserCustomSettings
  description: 'The UserCustomSettings resource provides methods that allow you to manage the custom settings for a user.


    Custom settings are a flexible way to store and retrieve custom user information that can be used in your own system.


    There is a limit on the size for all the custom user settings for a single user. All the custom user settings for a single user is limited to 4,000 characters, which includes the xml and json structure for the settings.'
paths:
  /v2/accounts/{accountId}/users/{userId}/custom_settings:
    get:
      tags:
      - UserCustomSettings
      summary: Docusign Retrieves the custom user settings for a specified user
      description: 'Retrieves a list of custom user settings for a single user.


        Custom settings provide a flexible way to store and retrieve custom user information that can be used in your own system.


        ###### Note: Custom user settings are not the same as user account settings.


        ###Getting Grouped Custom User Settings###


        If the custom user settings you want to retrieve are grouped, you must include the following information in the header, after Content-Type, in the request:


        `X-DocuSign-User-Settings-Key:group_name`


        Where the `group_name` is your designated name for the group of customer user settings.


        If the extra header information is not included, only the custom user settings that were added without a group are retrieved.'
      operationId: UserCustomSettings_GetCustomSettings
      parameters:
      - name: accountId
        in: path
        description: The external account number (int) or account id GUID.
        required: true
        schema:
          type: string
      - name: userId
        in: path
        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.'
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Successful response.
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/customSettingsInformation'
        '400':
          description: Error encountered.
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/errorDetails'
      deprecated: false
      x-ds-methodname: listCustomSettings
      x-ds-method: list
      x-ds-service: Users
      x-ds-in-sdk: true
    put:
      tags:
      - UserCustomSettings
      summary: Docusign Adds or updates custom user settings for the specified user
      description: 'Adds or updates custom user settings for the specified user.


        ###### Note: Custom user settings are not the same as user account settings.


        Custom settings provide a flexible way to store and retrieve custom user information that you can use in your own system.


        **Important**: There is a limit on the size for all the custom user settings for a single user. The limit is 4,000 characters, which includes the XML and JSON structure for the settings.


        ### Grouping Custom User Settings ###


        You can group custom user settings when adding them. Grouping allows you to retrieve settings that are in a specific group, instead of retrieving all the user custom settings.


        To group custom user settings, add the following information in the header, after Content-Type:


        `X-DocuSign-User-Settings-Key:group_name`


        Where the `group_name` is your designated name for the group of customer user settings. Grouping is shown in the Example Request Body below.


        When getting or deleting grouped custom user settings, you must include the extra header information.


        Grouping custom user settings is not required and if the extra header information is not included, the custom user settings are added normally and can be retrieved or deleted without including the additional header.'
      operationId: UserCustomSettings_PutCustomSettings
      parameters:
      - name: accountId
        in: path
        description: The external account number (int) or account id GUID.
        required: true
        schema:
          type: string
      - name: userId
        in: path
        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.'
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/customSettingsInformation'
          application/xml:
            schema:
              $ref: '#/components/schemas/customSettingsInformation'
        required: false
      responses:
        '200':
          description: Successful response.
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/customSettingsInformation'
        '400':
          description: Error encountered.
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/errorDetails'
      deprecated: false
      x-ds-methodname: updateCustomSettings
      x-ds-method: update
      x-ds-service: Users
      x-ds-in-sdk: true
      x-codegen-request-body-name: customSettingsInformation
    delete:
      tags:
      - UserCustomSettings
      summary: Docusign Deletes custom user settings for a specified user
      description: 'Deletes the specified custom user settings for a single user.


        ###Deleting Grouped Custom User Settings###


        If the custom user settings you want to delete are grouped, you must include the following information in the header, after Content-Type, in the request:


        `X-DocuSign-User-Settings-Key:group_name`


        Where the `group_name` is your designated name for the group of customer user settings.


        If the extra header information is not included, only the custom user settings that were added without a group are deleted.'
      operationId: UserCustomSettings_DeleteCustomSettings
      parameters:
      - name: accountId
        in: path
        description: The external account number (int) or account id GUID.
        required: true
        schema:
          type: string
      - name: userId
        in: path
        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.'
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/customSettingsInformation'
          application/xml:
            schema:
              $ref: '#/components/schemas/customSettingsInformation'
        required: false
      responses:
        '200':
          description: Successful response.
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/customSettingsInformation'
        '400':
          description: Error encountered.
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/errorDetails'
      deprecated: false
      x-ds-methodname: deleteCustomSettings
      x-ds-method: delete
      x-ds-service: Users
      x-ds-in-sdk: true
      x-codegen-request-body-name: customSettingsInformation
    servers:
    - url: https://www.docusign.net/restapi
  /v2.1/accounts/{accountId}/users/{userId}/custom_settings:
    parameters: []
    get:
      tags:
      - UserCustomSettings
      summary: Retrieves the custom user settings for a specified user
      description: 'Retrieves a list of custom user settings for a single user.


        Custom settings provide a flexible way to store and retrieve

        custom user information that can be used in your own system.


        **Note:** Custom user settings are not the same as user account

        settings.


        If the custom user settings you want to retrieve are grouped, you

        must include the `X-DocuSign-User-Settings-Key` header

        in the request:


        `X-DocuSign-User-Settings-Key:group_name`


        Where the `group_name` is your designated name for the group of

        customer user settings.


        If the `X-DocuSign-User-Settings-Key` header is not included, only the custom

        user settings that were added without a group are retrieved.'
      operationId: getV21AccountsByAccountIdUsersByUserIdCustomSettings
      parameters:
      - name: accountId
        in: path
        description: The external account number (int) or account ID GUID.
        required: true
        schema:
          type: string
      - name: userId
        in: path
        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.'
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Successful response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/customSettingsInformation'
        '400':
          description: Error encountered.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/errorDetails_2'
      deprecated: false
      x-ds-methodname: listCustomSettings
      x-ds-method: list
      x-ds-service: Users
      x-ds-in-sdk: true
      x-operation-id-source: normalized
      x-operation-id-original: UserCustomSettings_GetCustomSettings
    put:
      tags:
      - UserCustomSettings
      summary: Adds or updates custom user settings for the specified user
      description: 'Adds or updates custom user settings for the specified user.


        **Note:** Custom user settings are not the same as user account

        settings.


        Custom settings provide a flexible way to store and retrieve

        custom user information that you can use in your own system.


        **Important:** There is a limit on the size for all the custom

        user settings for a single user. The limit is 4,000 characters,

        which includes the XML and JSON structure for the settings.


        You can group custom user settings when adding them. Grouping

        allows you to retrieve settings that are in a specific group,

        instead of retrieving all the user custom settings.


        To group custom user settings, include the

        `X-DocuSign-User-Settings-Key` header in the request:


        `X-DocuSign-User-Settings-Key:group_name`


        Where the `group_name` is your designated name for the group of

        customer user settings.


        When getting or deleting grouped custom user settings, you must

        include the `X-DocuSign-User-Settings-Key` header information.


        Grouping custom user settings is not required and if the `X-DocuSign-User-Settings-Key`

        header information is not included, the custom user settings are

        added normally and can be retrieved or deleted without including

        the `X-DocuSign-User-Settings-Key` header.'
      operationId: putV21AccountsByAccountIdUsersByUserIdCustomSettings
      parameters:
      - name: accountId
        in: path
        description: The external account number (int) or account ID GUID.
        required: true
        schema:
          type: string
      - name: userId
        in: path
        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.'
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Successful response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/customSettingsInformation'
        '400':
          description: Error encountered.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/errorDetails_2'
      deprecated: false
      x-ds-methodname: updateCustomSettings
      x-ds-method: update
      x-ds-service: Users
      x-ds-in-sdk: true
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/customSettingsInformation'
          application/xml:
            schema:
              $ref: '#/components/schemas/customSettingsInformation'
      x-operation-id-source: normalized
      x-operation-id-original: UserCustomSettings_PutCustomSettings
    delete:
      tags:
      - UserCustomSettings
      summary: Deletes custom user settings for a specified user
      description: 'Deletes the specified custom user settings for a single user.


        If the custom user settings you want to delete are grouped, you

        must include the `X-DocuSign-User-Settings-Key` header

        in the request:


        `X-DocuSign-User-Settings-Key:group_name`


        Where the `group_name` is your designated name for the group of

        customer user settings.


        If the `X-DocuSign-User-Settings-Key` header is not included,

        only the custom user settings that were added without

        a group are deleted.'
      operationId: deleteV21AccountsByAccountIdUsersByUserIdCustomSettings
      parameters:
      - name: accountId
        in: path
        description: The external account number (int) or account ID GUID.
        required: true
        schema:
          type: string
      - name: userId
        in: path
        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.'
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Successful response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/customSettingsInformation'
        '400':
          description: Error encountered.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/errorDetails_2'
      deprecated: false
      x-ds-methodname: deleteCustomSettings
      x-ds-method: delete
      x-ds-service: Users
      x-ds-in-sdk: true
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/customSettingsInformation'
          application/xml:
            schema:
              $ref: '#/components/schemas/customSettingsInformation'
      x-operation-id-source: normalized
      x-operation-id-original: UserCustomSettings_DeleteCustomSettings
    servers:
    - url: https://www.docusign.net/restapi
components:
  schemas:
    customSettingsInformation:
      type: object
      properties:
        customSettings:
          type: array
          description: The name/value pair information for the user custom setting.
          items:
            $ref: '#/components/schemas/nameValue'
      description: ''
      x-ds-definition-name: customSettingsInformation
      x-ms-summary: ''
    nameValue:
      type: object
      properties:
        errorDetails:
          $ref: '#/components/schemas/errorDetails'
        name:
          type: string
          description: The name or key of a name/value pair.
        originalValue:
          type: string
          description: 'The initial value of the tab when it was sent to the recipient. '
        value:
          type: string
          description: The value field of a name/value pair.
      description: ''
      x-ds-definition-name: nameValue
      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.
    nameValue_2:
      type: object
      properties:
        errorDetails:
          $ref: '#/components/schemas/errorDetails_2'
          description: This object describes errors that occur. It is only valid for responses and ignored in requests.
        name:
          description: The name of the item.
          type: string
        originalValue:
          description: The initial value of the item.
          type: string
        value:
          description: The current value of the item.
          type: string
      description: A name-value pair that describes an item and provides a value for the item.
      x-ds-definition-name: nameValue
      x-ms-summary: A name-value pair that describes an item and provides a value for the item.
    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.
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'