{ "swagger": "2.0", "info": { "version": "v2.1", "title": "Docusign Admin API", "description": "An API for an organization administrator to manage organizations, accounts and users", "contact": { "name": "Docusign Developer Center", "url": "https://developers.docusign.com", "email": "devcenter@docusign.com" }, "termsOfService": "https://www.docusign.com/company/terms-and-conditions/developers" }, "host": "api.docusign.net", "basePath": "/Management", "schemes": [ "https" ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "externalDocs": { "description": "See the Docusign Admin API Guide for more information.", "url": "https://developers.docusign.com/docs/admin-api/reference" }, "paths": { "/v2/organizations": { "get": { "tags": [ "Organization" ], "summary": "Returns a list of organizations that the authenticated user belongs to.", "description": "Returns a list of organizations that the authenticated user belongs to.\n\nNote that the Docusign Admin API only returns JSON, not XML.\n\n[Required authentication scopes](/docs/admin-api/admin101/auth/): `organization_read`.\n\nThis method requires user authentication. It will fail with an [application access token](/docs/admin-api/admin101/application-auth/).", "operationId": "Organization_Organization_GetListV2", "produces": [ "application/json" ], "parameters": [ { "name": "mode", "in": "query", "description": "Specifies how to select the organizations. Valid values:\n\n- `org_admin`: Returns organizations for which the authenticated user is an admin.\n- `account_membership`: Returns organizations that contain an account of which the authenticated user is a member\n\nDefault value: `org_admin`", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OrganizationsResponse" } } }, "security": [ { "accessCode": [ "organization_read" ] } ], "x-ds-methodname": "getOrganizations", "x-ds-method": "getOrganizations", "x-ds-service": "Accounts", "x-ds-in-sdk": true } }, "/v2/data_redaction/accounts/{accountId}/user": { "post": { "tags": [ "DataDeletion" ], "summary": "Deletes membership data for a user on an account.", "description": "Deletes the data for a single account membership for a specified user.\n\nTo call this endpoint: \n* You must be an administrator (or delegated administrator) of the specified account.\n* The user must have been closed for at least 24 hours.\n\n**Note:** After a user's data is deleted for every account to which they belong, their user-level data will automatically be deleted.\n\n[Required authentication scopes](/docs/admin-api/admin101/auth/): `user_data_redact`.\n\n### Related topics\n\n- [How to delete user data from an account as an account admin](/docs/admin-api/how-to/account-admin-delete-user-data/)\n", "operationId": "DataRedaction_RedactIndividualMembershipData", "consumes": [ "application/json" ], "produces": [ "application/json" ], "parameters": [ { "name": "accountId", "in": "path", "description": "The ID of the account from which to delete the user's data.\n", "required": true, "type": "string", "format": "uuid" }, { "name": "requestModel", "in": "body", "description": "", "required": true, "schema": { "$ref": "#/definitions/IndividualMembershipDataRedactionRequest" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/IndividualUserDataRedactionResponse" } } }, "security": [ { "accessCode": [ "user_data_redact" ] } ], "x-ds-methodname": "redactIndividualMembershipData", "x-ds-method": "redactIndividualMembershipData", "x-ds-service": "Accounts", "x-ds-in-sdk": true } }, "/v2/organizations/{organizationId}/accounts/{accountId}/permissions": { "get": { "tags": [ "eSignUserManagement" ], "summary": "Returns the list of permission profiles in an account.", "description": "Returns the list of permission profiles in an account.\n\n[Required authentication scopes](/docs/admin-api/admin101/auth/): `permission_read`.\n\n\n### Related topics\n\n- [How to create a new active eSignature user](/docs/admin-api/how-to/create-active-user/)\n", "operationId": "Account_Accounts_GetPermissionProfilesV2", "produces": [ "application/json" ], "parameters": [ { "name": "organizationId", "in": "path", "description": "The organization ID Guid", "required": true, "type": "string", "format": "uuid" }, { "name": "accountId", "in": "path", "description": "The account ID Guid", "required": true, "type": "string", "format": "uuid" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/PermissionsResponse" } } }, "security": [ { "accessCode": [ "permission_read" ] } ], "x-ds-methodname": "getPermissions", "x-ds-method": "getPermissions", "x-ds-service": "Accounts", "x-ds-in-sdk": true } }, "/v2/organizations/{organizationId}/accounts/{accountId}/groups": { "get": { "tags": [ "eSignUserManagement" ], "summary": "Returns the list of groups in an account.", "description": "Returns the list of groups in an account.\n\n[Required authentication scopes](/docs/admin-api/admin101/auth/): `group_read`.\n\n\n\n### Related topics\n\n- [How to create a new active eSignature user](/docs/admin-api/how-to/create-active-user/)", "operationId": "Account_Accounts_GetGroupsV2", "produces": [ "application/json" ], "parameters": [ { "name": "organizationId", "in": "path", "description": "The organization ID Guid", "required": true, "type": "string", "format": "uuid" }, { "name": "accountId", "in": "path", "description": "The account ID Guid", "required": true, "type": "string", "format": "uuid" }, { "name": "start", "in": "query", "description": "Index of first item to include in the response. The default value is 0.", "required": false, "type": "integer", "format": "int32" }, { "name": "take", "in": "query", "description": "Page size of the response. The default value is 20.", "required": false, "type": "integer", "format": "int32" }, { "name": "end", "in": "query", "description": "Index of the last item to include in the response. Ignored if `take` parameter is specified.", "required": false, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/MemberGroupsResponse" } } }, "security": [ { "accessCode": [ "group_read" ] } ], "x-ds-methodname": "getGroups", "x-ds-method": "getGroups", "x-ds-service": "Accounts", "x-ds-in-sdk": true } }, "/v2/organizations/{organizationId}/exports/user_list": { "get": { "tags": [ "UserExport" ], "summary": "Returns a list of pending and completed export requests.", "description": "Returns a list of pending and completed export requests.\n\n[Required authentication scopes](/docs/admin-api/admin101/auth/): `user_read`.\n", "operationId": "OrganizationExport_OrganizationExport_Get", "produces": [ "application/json" ], "parameters": [ { "name": "organizationId", "in": "path", "description": "The organization ID Guid", "required": true, "type": "string", "format": "uuid" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OrganizationExportsResponse" } } }, "security": [ { "accessCode": [ "user_read" ] } ], "x-ds-methodname": "getUserListExports", "x-ds-method": "getUserListExports", "x-ds-service": "BulkExports", "x-ds-in-sdk": true }, "post": { "tags": [ "UserExport" ], "summary": "Creates a user list export request.", "description": "Create a user list export request.\n\nThis method initiates a user list export request. You specify the type of export request as JSON in the body of method, like this:\n\n``` json\n{\n\t\"type\": \"organization_memberships_export\"\n}\n```\n\nThe export request type is one of three values:\n\n| Value | Description |\n| :----------------------------------------- | :------------------------------------------------------------------------------------------------------ |\n| `organization_memberships_export` | Every user in every account in the organization. Users in multiple accounts will appear more than once. |\n| `organization_domain_users_export` | All users of the reserved domains. |\n| `organization_external_memberships_export` | Users whose email address domain is *not* linked to the organization. |\n\n[Required authentication scopes](/docs/admin-api/admin101/auth/): `user_read`.\n\n### Next steps\n* See [how this endpoint is used to bulk export user data](/docs/admin-api/how-to/bulk-export-users/).", "operationId": "OrganizationExport_OrganizationExport_Insert", "consumes": [ "application/json" ], "produces": [ "application/json" ], "parameters": [ { "name": "organizationId", "in": "path", "description": "The organization ID Guid", "required": true, "type": "string", "format": "uuid" }, { "name": "request", "in": "body", "description": "", "required": true, "schema": { "$ref": "#/definitions/OrganizationExportRequest" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OrganizationExportResponse" } } }, "security": [ { "accessCode": [ "user_read" ] } ], "x-ds-methodname": "createUserListExport", "x-ds-method": "createUserListExport", "x-ds-service": "BulkExports", "x-ds-in-sdk": true } }, "/v2/organizations/{organizationId}/exports/account_settings": { "get": { "tags": [ "AccountSettingsExport" ], "summary": "Returns a list of pending and completed account settings export request.", "description": "Returns a list of pending and completed account settings export requests.\n\n[Required authentication scopes](/docs/admin-api/admin101/auth/): `account_read`.", "operationId": "OrganizationExport_OrganizationExport_GetAccountCompare", "produces": [ "application/json" ], "parameters": [ { "name": "organizationId", "in": "path", "description": "The organization ID Guid", "required": true, "type": "string", "format": "uuid" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OrganizationExportsResponse" } } }, "security": [ { "accessCode": [ "account_read" ] } ], "x-ds-methodname": "getAccountSettingsExports", "x-ds-method": "getAccountSettingsExports", "x-ds-service": "BulkExports", "x-ds-in-sdk": true }, "post": { "tags": [ "AccountSettingsExport" ], "summary": "Creates a new account settings export request.", "description": "Creates a new account settings export request.\n\nTo learn more about exporting account settings,\nsee [Account Settings Export][guide-export]\nin the Docusign Admin Guide.\n\nYou can export settings for up to 40 accounts at a time.\n\nSpecify the accounts whose settings you are requesting as JSON in the body of the request, like this:\n\n``` json\n{\n \"accounts\":\t[\n \t{ \"account_id\": \"9ca037f4-xxxx-xxxx-xxxx-212e57d4f22e\"},\n \t{ \"account_id\": \"624e3e00-xxxx-xxxx-xxxx-43918c520dab\"}\n\n ]\n}\n```\n\n[Required authentication scopes](/docs/admin-api/admin101/auth/): `account_write`.\n\n### Related topics\n\n- [Account Settings import][guide-import] guide\n- [Account Settings Export][guide-export] guide\n\n\n[guide-import]: https://support.docusign.com/s/document-item?bundleId=rrf1583359212854&topicId=nwl1583359167434.html\n[guide-export]: https://support.docusign.com/s/document-item?bundleId=rrf1583359212854&topicId=kfj1583359164049.html", "operationId": "OrganizationExport_OrganizationExport_AccountCompare", "consumes": [ "application/json" ], "produces": [ "application/json" ], "parameters": [ { "name": "organizationId", "in": "path", "description": "The organization ID Guid", "required": true, "type": "string", "format": "uuid" }, { "name": "request", "in": "body", "description": "", "required": true, "schema": { "$ref": "#/definitions/OrganizationAccountsRequest" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OrganizationExportResponse" } } }, "security": [ { "accessCode": [ "account_read" ] } ], "x-ds-methodname": "createAccountSettingsExport", "x-ds-method": "createAccountSettingsExport", "x-ds-service": "BulkExports", "x-ds-in-sdk": true } }, "/v2/organizations/{organizationId}/exports/user_list/{exportId}": { "get": { "tags": [ "UserExport" ], "summary": "Returns the results for single user list export request.", "description": "Returns the results for single user list export request.\n\nGiven an export ID, this method returns the results of a single user list export request.\nTo get a list of all the export requests, use `getUserListExports`.\n\nNote that the `metadata_url` property of the response from `createUserListExport` is a read-to-use HTTP GET request to get the status.\n\nThe results are available through a URL that\nyou can access through the `results` property of the response.\nFor example, to get the URL of the first result you might use\n`results[0].url`\n\n[Required authentication scopes](/docs/admin-api/admin101/auth/): `user_read`.\n\n### Next steps\n* See [how this endpoint is used to bulk export user data](/docs/admin-api/how-to/bulk-export-users/).", "operationId": "OrganizationExport_OrganizationExport_GetByExportId", "produces": [ "application/json" ], "parameters": [ { "name": "organizationId", "in": "path", "description": "The organization ID Guid", "required": true, "type": "string", "format": "uuid" }, { "name": "exportId", "in": "path", "description": "The export ID GUID for the request.", "required": true, "type": "string", "format": "uuid" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OrganizationExportResponse" } } }, "security": [ { "accessCode": [ "user_read" ] } ], "x-ds-methodname": "getUserListExport", "x-ds-method": "getUserListExport", "x-ds-service": "BulkExports", "x-ds-in-sdk": true }, "delete": { "tags": [ "UserExport" ], "summary": "Deletes a single user list export request.", "description": "Deletes a single user list export request.\nUse this method to delete pending or completed user export requests.\n\n[Required authentication scopes](/docs/admin-api/admin101/auth/): `user_read`.\n\n", "operationId": "OrganizationExport_OrganizationExport_DeleteByExportId", "produces": [ "application/json" ], "parameters": [ { "name": "organizationId", "in": "path", "description": "The organization ID Guid", "required": true, "type": "string", "format": "uuid" }, { "name": "exportId", "in": "path", "description": "The export ID GUID for the request.", "required": true, "type": "string", "format": "uuid" } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "accessCode": [ "user_read" ] } ], "x-ds-methodname": "deleteUserListExport", "x-ds-method": "deleteUserListExport", "x-ds-service": "BulkExports", "x-ds-in-sdk": true } }, "/v2/organizations/{organizationId}/exports/account_settings/{exportId}": { "get": { "tags": [ "AccountSettingsExport" ], "summary": "Returns the results for a single account settings export request.", "description": "Returns the results for a single account settings export request.\n\nGiven an export ID, this method returns the results of an account settings export request.\nTo get a list of all the export requests, use `getAccountSettingsExports`.\n\nThe results are available through a URL that\nyou can access through the `results` property of the response.\nFor example, to get the URL of first result you might use\n`results[0].url`\n\nThe settings export is formatted like this:\n\n``` json\n{\n \"accounts\": [\n {\n \"account_id\": \"9ca037f4-xxxx-xxxx-xxxx-212e57d4f22e\",\n \"name\": \"The Happy Company\",\n . . .\n },\n {\n \"account_id\": \"624e3e00-xxxx-xxxx-xxxx-43918c520dab\",\n \"name\": \"LoanCo\",\n . . .\n }\n ],\n \"settings\": [\n . . .\n {\n \"category\": \"Signing\",\n \"name\": \"SignerCanSignOnMobile\",\n \"account_values\": [\n {\n \"account_id\": \"9ca037f4-xxxx-xxxx-xxxx-212e57d4f22e\",\n \"value\": \"true\",\n \"rights\": \"editable\"\n },\n {\n \"account_id\": \"624e3e00-xxxx-xxxx-xxxx-43918c520dab\",\n \"value\": \"true\",\n \"rights\": \"editable\"\n }\n ]\n },\n . . .\n ]\n}\n\n```\n\n[Required authentication scopes](/docs/admin-api/admin101/auth/): `account_read`.", "operationId": "OrganizationExport_OrganizationExport_GetAccountSettingsExportByExportId", "produces": [ "application/json" ], "parameters": [ { "name": "organizationId", "in": "path", "description": "The organization ID Guid", "required": true, "type": "string", "format": "uuid" }, { "name": "exportId", "in": "path", "description": "The export ID GUID for the request.", "required": true, "type": "string", "format": "uuid" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OrganizationExportResponse" } } }, "security": [ { "accessCode": [ "account_read" ] } ], "x-ds-methodname": "getAccountSettingsExport", "x-ds-method": "getAccountSettingsExport", "x-ds-service": "BulkExports", "x-ds-in-sdk": true }, "delete": { "tags": [ "AccountSettingsExport" ], "summary": "Deletes a single account settings export request.", "description": "Deletes a single account settings export request.\nAny data associated with the request is also deleted.\n\n[Required authentication scopes](/docs/admin-api/admin101/auth/): `account_read`.\n", "operationId": "OrganizationExport_OrganizationExport_DeleteByAccountSettingsExportId", "produces": [ "application/json" ], "parameters": [ { "name": "organizationId", "in": "path", "description": "The organization ID Guid", "required": true, "type": "string", "format": "uuid" }, { "name": "exportId", "in": "path", "description": "The export ID GUID for the request.", "required": true, "type": "string", "format": "uuid" } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "accessCode": [ "account_read" ] } ], "x-ds-methodname": "deleteAccountSettingsExport", "x-ds-method": "deleteAccountSettingsExport", "x-ds-service": "BulkExports", "x-ds-in-sdk": true } }, "/v2/organizations/{organizationId}/imports/account_settings": { "get": { "tags": [ "AccountSettingsImport" ], "summary": "Returns the details and metadata for Bulk Account Settings Import requests in the organization.", "description": "Returns the details and metadata for Bulk Account Settings Import requests in the organization.\n\n[Required authentication scopes](/docs/admin-api/admin101/auth/): `account_read`.", "operationId": "OrganizationImport_OrganizationImportAccountSettings_Get", "consumes": [ "application/json" ], "produces": [ "application/json" ], "parameters": [ { "name": "organizationId", "in": "path", "description": "The organization ID Guid", "required": true, "type": "string", "format": "uuid" } ], "responses": { "200": { "description": "OK", "schema": { "type": "array", "items": { "$ref": "#/definitions/OrganizationAccountSettingsImportResponse" } } } }, "security": [ { "accessCode": [ "account_read" ] } ], "x-ds-methodname": "getBulkAccountSettingsImports", "x-ds-method": "getBulkAccountSettingsImports", "x-ds-service": "BulkImports", "x-ds-in-sdk": true }, "post": { "tags": [ "AccountSettingsImport" ], "summary": "Creates a new account settings import request.", "description": "Creates a new account settings import request.\n\nThe request for this method consists of\nthe contents of a CSV\nfile.\n\nYou can export your current settings as a CSV file with\n[AccountSettingsExport: createAccountSettingsExport](/docs/admin-api/reference/bulkoperations/accountsettingsexport/createaccountsettingsexport/)\nand use it as the basis\nof the changes you want to import.\n\n\nTo learn more about the format\nof a settings CSV file, see\n[Preparing a CSV for account settings import][guide-import]\nin the Docusign Admin Guide.\n\nYou can import settings for up to 40 accounts at a time.\n\n[Required authentication scopes](/docs/admin-api/admin101/auth/): `account_write`.\n\n### Related topics\n\n- [Account Settings import][guide-import] guide\n- [Account Settings Export][guide-export] guide\n\n[guide-import]: https://support.docusign.com/s/document-item?bundleId=rrf1583359212854&topicId=nwl1583359167434.html\n[guide-export]: https://support.docusign.com/s/document-item?bundleId=rrf1583359212854&topicId=kfj1583359164049.html\n", "operationId": "OrganizationImport_OrganizationImportAccountSettings_Post", "consumes": [ "multipart/form-data" ], "produces": [ "application/json" ], "parameters": [ { "name": "organizationId", "in": "path", "description": "The organization ID GUID.", "required": true, "type": "string", "format": "uuid" }, { "name": "file.csv", "in": "formData", "description": "CSV file.", "required": true, "type": "file" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OrganizationAccountSettingsImportResponse" } } }, "security": [ { "accessCode": [ "account_write" ] } ], "x-ds-methodname": "addBulkAccountSettingsImport", "x-ds-method": "addBulkAccountSettingsImport", "x-ds-service": "BulkImports", "x-ds-in-sdk": true } }, "/v2/organizations/{organizationId}/imports/account_settings/{importId}": { "get": { "tags": [ "AccountSettingsImport" ], "summary": "Returns the details/metadata for a Bulk Account Settings Import request.", "description": "Returns the details/metadata for a Bulk Account Settings Import request.\n\nGiven an import ID, this method returns the results of an account settings import request.\nTo get a list of all the import requests, use `getAccountSettingsImports`.\n\n[Required authentication scopes](/docs/admin-api/admin101/auth/): `account_read`.\n", "operationId": "OrganizationImport_OrganizationImportAccountSettings_GetById", "consumes": [ "application/json" ], "produces": [ "application/json" ], "parameters": [ { "name": "organizationId", "in": "path", "description": "The organization ID Guid", "required": true, "type": "string", "format": "uuid" }, { "name": "importId", "in": "path", "description": "The import ID GUID for the request.", "required": true, "type": "string", "format": "uuid" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OrganizationAccountSettingsImportResponse" } } }, "security": [ { "accessCode": [ "account_read" ] } ], "x-ds-methodname": "getBulkAccountSettingsImport", "x-ds-method": "getBulkAccountSettingsImport", "x-ds-service": "BulkImports", "x-ds-in-sdk": true }, "delete": { "tags": [ "AccountSettingsImport" ], "summary": "Deletes a Bulk Account Settings Import request.", "description": "Deletes a single account settings import request.\nAny data associated with the request is also deleted.\n\n[Required authentication scopes](/docs/admin-api/admin101/auth/): `account_write`.", "operationId": "OrganizationImport_OrganizationImportAccountSettings_DeleteById", "consumes": [ "application/json" ], "produces": [ "application/json" ], "parameters": [ { "name": "organizationId", "in": "path", "description": "The organization ID Guid", "required": true, "type": "string", "format": "uuid" }, { "name": "importId", "in": "path", "description": "The import ID GUID for the request.", "required": true, "type": "string", "format": "uuid" } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "accessCode": [ "account_write" ] } ], "x-ds-methodname": "deleteBulkAccountSettingsImport", "x-ds-method": "deleteBulkAccountSettingsImport", "x-ds-service": "BulkImports", "x-ds-in-sdk": true } }, "/v2/organizations/{organizationId}/imports/bulk_users/add": { "post": { "tags": [ "UserImport" ], "summary": "Creates a request to import new users into an account.", "description": "Creates a request to import new users.\n\nYour CSV import file is made up of a header row with the column headers and a row of user or account data for each user you want to add to an account. Only new users can be imported. Any changes to existing users will be ignored. To make changes to existing users, use [UserImport:updateBulkUserImports](/docs/admin-api/reference/bulkoperations/userimport/updatebulkuserimports/).\n\nTo ensure your CSV file is properly formatted, follow the requirements in the Support article [Build a CSV to Bulk Add Users](https://support.docusign.com/s/document-item?bundleId=rrf1583359212854&topicId=wec1593211169952.html). You can download an example file from the Add Users dialogue in the Admin UI.\n\nYou can add up to 2,000 users to an account and include up to 50 accounts per import. The maximum number of users per import is 8,000.\n\n[Required authentication scopes](/docs/admin-api/admin101/auth/): `user_write`.\n\n### Next steps\n* See an [example of adding users via bulk import in your chosen programming language](/docs/admin-api/how-to/add-users-bulk-import/).\n", "operationId": "OrganizationImport_OrganizationImportUsers_Insert", "consumes": [ "multipart/form-data" ], "produces": [ "application/json" ], "parameters": [ { "name": "organizationId", "in": "path", "description": "The organization ID Guid", "required": true, "type": "string", "format": "uuid" }, { "name": "file.csv", "in": "formData", "description": "CSV file.", "required": true, "type": "file" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OrganizationImportResponse" } } }, "security": [ { "accessCode": [ "user_write" ] } ], "x-ds-methodname": "addBulkUserImport", "x-ds-method": "addBulkUserImport", "x-ds-service": "BulkImports", "x-ds-in-sdk": true } }, "/v2/organizations/{organizationId}/accounts/{accountId}/imports/bulk_users/add": { "post": { "tags": [ "SingleAccountUserImport" ], "summary": "Import request for adding a user to a single account within the organization.", "description": "Import request for adding a user to a single account within the organization.\nThis method lets you upload user information without requiring an AccountId column.\n\n[Required authentication scopes](/docs/admin-api/admin101/auth/): `user_write`.\n", "operationId": "OrganizationImport_OrganizationImportSingleAccountUsers_Insert", "consumes": [ "multipart/form-data" ], "produces": [ "application/json" ], "parameters": [ { "name": "organizationId", "in": "path", "description": "The organization ID Guid", "required": true, "type": "string", "format": "uuid" }, { "name": "accountId", "in": "path", "description": "The account ID Guid", "required": true, "type": "string", "format": "uuid" }, { "name": "file.csv", "in": "formData", "description": "CSV file.", "required": true, "type": "file" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OrganizationImportResponse" } } }, "security": [ { "accessCode": [ "user_write" ] } ], "x-ds-methodname": "createBulkImportSingleAccountAddUsersRequest", "x-ds-method": "createBulkImportSingleAccountAddUsersRequest", "x-ds-service": "BulkImports", "x-ds-in-sdk": true } }, "/v2/organizations/{organizationId}/imports/bulk_users/update": { "post": { "tags": [ "UserImport" ], "summary": "Bulk updates information for existing users.", "description": "Bulk updates information for existing users.\n\nYour CSV import file is made up of a header row with the column headers and a row of user or account data for each user you want to add to an account. \n\n\n**Update limit:** You can update up to 2,000 users on an account and include up to 50 accounts per import. The maximum number of updated users per import is 8,000.\n\nThis method requires the following HTTP headers:\n\n| Header | Value |\n| :--- | :--- |\n| Content-Type | `text/csv` |\n| Content-Disposition | `filename=filename.csv` |\n\n\n\nTo ensure your CSV is properly formatted, use the\n[Sample Bulk Update CSV file](https://admin.docusign.com/static-resources/organization-user-update-import.csv)\n as a template. The following table describes the columns.\n\nNote that the columns for bulk adding users and bulk update users are slightly different.\nThe update CSV file requires an `APIUserName` column, and does not have an `AutoActivate` column.\n\n\n\n| Column | Required | Description |\n| :------------------ | :------- | :------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |\n| AccountID | yes | The 32-character API account ID of the user's account in your organization. You can find this value in the API and Keys section of the Admin area of the account. |\n| AccountName | | The name of the user's account in your organization. The account name must match the account ID provided. |\n| FirstName | yes | The user's first name. |\n| LastName | yes | The user's last name. |\n| UserEmail | yes | The user's complete email address. |\n| PermissionSet | yes | The user's permission set. The PermissionSet value must match an existing permission set for the account. This value is not case sensitive. |\n| UserTitle | | The user's job title. |\n| CompanyName | | The user's company name. |\n| Group | | The user's assigned groups. The Group values must match existing Group names for the account. Additional Group columns can be added to the file to add users to more than one group. You do not need to add users to the Everyone group, since all new users are automatically added to that group. |\n| AddressLine1 | | The user's address, first line. |\n| AddressLine2 | | The user's address, second line. |\n| City | | The user's city name. |\n| StateRegionProvince | | The user's regional location. |\n| PostalCode | | The user's postal code. |\n| Phone | | The user's phone number. |\n| Language | | The user's display language for their Docusign account. Must be one of: |\n| LoginPolicy | | The user's login policy. Valid values include the following: For more information on login policies, see [Setting User Login Policy](https://support.docusign.com/s/document-item?bundleId=rrf1583359212854&topicId=zah1583359147774.html). |\n| AutoActivate | | For domain users, new users can be activated automatically for domain accounts using SSO by setting the value to **true.** The user is activated automatically once the import is complete. Memberships activated in this way do not receive an activation email. |\n\n\n\n## Updating user email addresses\n\nChanging a user's email address should be done carefully. The user's email address is used to log in to Docusign and receive documents to sign from others.\nOnce changed, existing documents that were sent or received:\n\n- Will still appear in the user's documents list.\n- Notifications about these documents will be sent to the new email address. If someone sends a new document to the old email address:\n- Docusign will send a notification to the old address.\n- It will not appear in the documents list of the account.\n\nThis change of email address will be applied to all of the user's account memberships.\n\n[Required authentication scopes](/docs/admin-api/admin101/auth/): `user_write`.", "operationId": "OrganizationImport_OrganizationImportUsers_Update", "consumes": [ "multipart/form-data" ], "produces": [ "application/json" ], "parameters": [ { "name": "organizationId", "in": "path", "description": "The organization ID Guid", "required": true, "type": "string", "format": "uuid" }, { "name": "file.csv", "in": "formData", "description": "CSV file.", "required": true, "type": "file" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OrganizationImportResponse" } } }, "security": [ { "accessCode": [ "user_write" ] } ], "x-ds-methodname": "updateBulkUserImports", "x-ds-method": "updateBulkUserImports", "x-ds-service": "BulkImports", "x-ds-in-sdk": true } }, "/v2/organizations/{organizationId}/accounts/{accountId}/imports/bulk_users/update": { "post": { "tags": [ "SingleAccountUserImport" ], "summary": "Import request for updating users for a single account\nwithin the organization.", "description": "Import request for updating users for a single account\nwithin the organization.\n\nThis method lets you upload user information without requiring an `AccountId` column.\n\n[Required authentication scopes](/docs/admin-api/admin101/auth/): `user_write`.\n\n", "operationId": "OrganizationImport_OrganizationImportSingleAccountUsers_Update", "consumes": [ "multipart/form-data" ], "produces": [ "application/json" ], "parameters": [ { "name": "organizationId", "in": "path", "description": "The organization ID Guid", "required": true, "type": "string", "format": "uuid" }, { "name": "accountId", "in": "path", "description": "The account ID Guid", "required": true, "type": "string", "format": "uuid" }, { "name": "file.csv", "in": "formData", "description": "CSV file.", "required": true, "type": "file" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OrganizationImportResponse" } } }, "security": [ { "accessCode": [ "user_write" ] } ], "x-ds-methodname": "createBulkImportSingleAccountUpdateUsersRequest", "x-ds-method": "createBulkImportSingleAccountUpdateUsersRequest", "x-ds-service": "BulkImports", "x-ds-in-sdk": true } }, "/v2/organizations/{organizationId}/imports/bulk_users/close": { "post": { "tags": [ "UserImport" ], "summary": "Creates a request to close the accounts of existing users.", "description": "Creates a request to close the accounts of existing users.\n\nGiven a CSV list of users, close their accounts.\n\nYour CSV import file is made up of a header row with the column headers and a row of user or account data for each user whose account you want to close.\n\nTo ensure your CSV is properly formatted, use the\n[Sample Bulk Update CSV file](https://admin.docusign.com/static-resources/organization-user-update-import.csv)\n as a template. The following table describes the columns.\n\n\n\n\n| Column | Required | Description |\n| :------------------ | :------- | :------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |\n| AccountID | yes | The 32-character API account ID of the user's account in your organization. You can find this value in the API and Keys section of the Admin area of the account. |\n| AccountName | | The name of the user's account in your organization. The account name must match the account ID provided. |\n| FirstName | yes | The user's first name. |\n| LastName | yes | The user's last name. |\n| UserEmail | yes | The user's complete email address. |\n| PermissionSet | yes | The user's permission set. The PermissionSet value must match an existing permission set for the account. This value is not case sensitive. |\n\n[Required authentication scopes](/docs/admin-api/admin101/auth/): `user_write`.", "operationId": "OrganizationImport_OrganizationImportUsers_Close", "consumes": [ "multipart/form-data" ], "produces": [ "application/json" ], "parameters": [ { "name": "organizationId", "in": "path", "description": "The organization ID Guid", "required": true, "type": "string", "format": "uuid" }, { "name": "file.csv", "in": "formData", "description": "CSV file.", "required": true, "type": "file" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OrganizationImportResponse" } } }, "security": [ { "accessCode": [ "user_write" ] } ], "x-ds-methodname": "closeBulkUserImportRequest", "x-ds-method": "closeBulkUserImportRequest", "x-ds-service": "BulkImports", "x-ds-in-sdk": true } }, "/v2/organizations/{organizationId}/imports/bulk_users/close_external": { "post": { "tags": [ "UserImport" ], "summary": "Closes external memberships.", "description": "Closes external memberships.\n\nExternal memberships are users who have an email address at a verified domain but do not belong to the organization.\n\n[Required authentication scopes](/docs/admin-api/admin101/auth/): `user_write`.\n", "operationId": "OrganizationImport_OrganizationImportUsers_CloseExternal", "consumes": [ "application/json" ], "produces": [ "application/json" ], "parameters": [ { "name": "organizationId", "in": "path", "description": "The organization ID Guid", "required": true, "type": "string", "format": "uuid" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OrganizationImportResponse" } } }, "security": [ { "accessCode": [ "user_write" ] } ], "x-ds-methodname": "closeBulkExternalUserImportRequest", "x-ds-method": "closeBulkExternalUserImportRequest", "x-ds-service": "BulkImports", "x-ds-in-sdk": true } }, "/v2/organizations/{organizationId}/imports/bulk_users": { "get": { "tags": [ "UserImport" ], "summary": "Gets a list of all of the user import requests.", "description": "Gets a list of all of the user import requests.\n\n[Required authentication scopes](/docs/admin-api/admin101/auth/): `user_read`.", "operationId": "OrganizationImport_OrganizationImportUsers_Get", "produces": [ "application/json" ], "parameters": [ { "name": "organizationId", "in": "path", "description": "The organization ID Guid", "required": true, "type": "string", "format": "uuid" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OrganizationImportsResponse" } } }, "security": [ { "accessCode": [ "user_read" ] } ], "x-ds-methodname": "getBulkUserImportRequests", "x-ds-method": "getBulkUserImportRequests", "x-ds-service": "BulkImports", "x-ds-in-sdk": true } }, "/v2/organizations/{organizationId}/imports/bulk_users/{importId}": { "get": { "tags": [ "UserImport" ], "summary": "Returns the details of a single user import request.", "description": "Returns the details of a single user import request.\n\nUse this method to check the status of the request by looking at the `status` property of the response.\nOnce the status becomes `completed` (or fails), use this method to get the details.\n\nTo get a list of all of the user import requests, use `getBulkUserImportRequests`.\n\n[Required authentication scopes](/docs/admin-api/admin101/auth/): `user_read`.", "operationId": "OrganizationImport_OrganizationImportUsers_GetById", "produces": [ "application/json" ], "parameters": [ { "name": "organizationId", "in": "path", "description": "The organization ID Guid", "required": true, "type": "string", "format": "uuid" }, { "name": "importId", "in": "path", "description": "The import ID GUID for the request.", "required": true, "type": "string", "format": "uuid" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OrganizationImportResponse" } } }, "security": [ { "accessCode": [ "user_read" ] } ], "x-ds-methodname": "getBulkUserImportRequest", "x-ds-method": "getBulkUserImportRequest", "x-ds-service": "BulkImports", "x-ds-in-sdk": true }, "delete": { "tags": [ "UserImport" ], "summary": "Deletes a specific user import request.", "description": "Deletes a specific import request and its results.\n\nTo delete a user, see [closeBulkUserImportRequest](/docs/admin-api/reference/bulkoperations/userimport/closebulkuserimportrequest/).\n\n[Required authentication scopes](/docs/admin-api/admin101/auth/): `user_write`.", "operationId": "OrganizationImport_OrganizationImportUsers_DeleteById", "produces": [ "application/json" ], "parameters": [ { "name": "organizationId", "in": "path", "description": "The organization ID Guid", "required": true, "type": "string", "format": "uuid" }, { "name": "importId", "in": "path", "description": "The import ID GUID for the request.", "required": true, "type": "string", "format": "uuid" } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "accessCode": [ "user_write" ] } ], "x-ds-methodname": "deleteBulkUserImport", "x-ds-method": "deleteBulkUserImport", "x-ds-service": "BulkImports", "x-ds-in-sdk": true } }, "/v2/organizations/{organizationId}/imports/bulk_users/{importId}/results_csv": { "get": { "tags": [ "UserImport" ], "summary": "Given the ID of a user import request,\nreturn the CSV file that was imported.", "description": "Returns the contents of the CSV file\nassociated with a user import request.\n\nThe results have an additional column,\n`ProcessingResults`,\nthat describes the results of importing that row.\n\n[Required authentication scopes](/docs/admin-api/admin101/auth/): `user_read`.\n", "operationId": "OrganizationImport_OrganizationImportUsers_GetCSVResults", "produces": [ "text/csv" ], "parameters": [ { "name": "organizationId", "in": "path", "description": "The organization ID Guid", "required": true, "type": "string", "format": "uuid" }, { "name": "importId", "in": "path", "description": "The import ID GUID for the request.", "required": true, "type": "string", "format": "uuid" } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "accessCode": [ "user_read" ] } ], "x-ds-methodname": "getBulkUserImportCSV", "x-ds-method": "getBulkUserImportCSV", "x-ds-service": "BulkImports", "x-ds-in-sdk": true } }, "/v2/organizations/{organizationId}/identity_providers": { "get": { "tags": [ "IdentityProviders" ], "summary": "Returns the list of identity providers for an organization.", "description": "Returns the list of identity providers for an organization.\n\n[Required authentication scopes](/docs/admin-api/admin101/auth/): `identity_provider_read`.", "operationId": "Organization_GetIdentityProviders", "produces": [ "application/json" ], "parameters": [ { "name": "organizationId", "in": "path", "description": "The organization ID Guid", "required": true, "type": "string", "format": "uuid" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/IdentityProvidersResponse" } } }, "security": [ { "accessCode": [ "identity_provider_read" ] } ], "x-ds-methodname": "getIdentityProviders", "x-ds-method": "getIdentityProviders", "x-ds-service": "IdentityProviders", "x-ds-in-sdk": true } }, "/v2/data_redaction/organizations/{organizationId}/user": { "post": { "tags": [ "DataDeletion" ], "summary": "Deletes data for one or more of a user's account memberships.", "description": "Deletes data for one or more of a user's account memberships.\n\nTo call this endpoint: \n* You must be an organization administrator (or delegated administrator) with permission to manage the specified accounts or the user's email domain.\n* The user must have been closed for at least 24 hours.\n\n**Note:** After a user's data is deleted for every account to which they belong, their user-level data will automatically be deleted.\n\n[Required authentication scopes](/docs/admin-api/admin101/auth/): `user_data_redact`.\n\n### Related topics\n\n- [How to delete user data from one or more accounts as an organization admin](/docs/admin-api/how-to/org-admin-delete-user-data/)", "operationId": "DataRedaction_RedactIndividualUserData", "consumes": [ "application/json" ], "produces": [ "application/json" ], "parameters": [ { "name": "organizationId", "in": "path", "description": "The organization ID Guid", "required": true, "type": "string", "format": "uuid" }, { "name": "requestModel", "in": "body", "description": "", "required": true, "schema": { "$ref": "#/definitions/IndividualUserDataRedactionRequest" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/IndividualUserDataRedactionResponse" } } }, "security": [ { "accessCode": [ "user_data_redact" ] } ], "x-ds-methodname": "redactIndividualUserData", "x-ds-method": "redactIndividualUserData", "x-ds-service": "Organizations", "x-ds-in-sdk": true } }, "/v2/organizations/{organizationId}/reserved_domains": { "get": { "tags": [ "ReservedDomains" ], "summary": "Returns the list of reserved domains for the organization.", "description": "Returns the list of reserved domains for the organization.\n\n[Required authentication scopes](/docs/admin-api/admin101/auth/): `domain_read`.", "operationId": "Organization_GetReservedDomains", "produces": [ "application/json" ], "parameters": [ { "name": "organizationId", "in": "path", "description": "The organization ID Guid", "required": true, "type": "string", "format": "uuid" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/DomainsResponse" } } }, "security": [ { "accessCode": [ "domain_read" ] } ], "x-ds-methodname": "getReservedDomains", "x-ds-method": "getReservedDomains", "x-ds-service": "ReservedDomains", "x-ds-in-sdk": true } }, "/v2/organizations/{organizationId}/users/profiles": { "post": { "tags": [ "eSignUserManagement" ], "summary": "Updates a user's information.", "description": "Updates a user's information.\n\n[Required authentication scopes](/docs/admin-api/admin101/auth/): `user_write`.", "operationId": "User_Users_UpdateV2", "consumes": [ "application/json" ], "produces": [ "application/json" ], "parameters": [ { "name": "apply_license_override", "in": "query", "description": "", "required": false, "type": "boolean" }, { "name": "organizationId", "in": "path", "description": "The organization ID Guid", "required": true, "type": "string", "format": "uuid" }, { "name": "request", "in": "body", "description": "", "required": true, "schema": { "$ref": "#/definitions/UpdateUsersRequest" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/UsersUpdateResponse" } } }, "security": [ { "accessCode": [ "user_write" ] } ], "x-ds-methodname": "updateUser", "x-ds-method": "updateUser", "x-ds-service": "Users", "x-ds-in-sdk": true } }, "/v2/organizations/{organizationId}/users/email_addresses": { "post": { "tags": [ "Users" ], "summary": "Updates a user's email address.", "description": "Updates a user's email address.\n\n[Required authentication scopes](/docs/admin-api/admin101/auth/): `user_write`.\n", "operationId": "User_Users_UpdateEmailAddressesV2", "consumes": [ "application/json" ], "produces": [ "application/json" ], "parameters": [ { "name": "organizationId", "in": "path", "description": "The organization ID Guid", "required": true, "type": "string", "format": "uuid" }, { "name": "request", "in": "body", "description": "", "required": true, "schema": { "$ref": "#/definitions/UpdateUsersEmailRequest" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/UsersUpdateResponse" } } }, "security": [ { "accessCode": [ "user_write" ] } ], "x-ds-methodname": "updateEmailAddress", "x-ds-method": "updateEmailAddress", "x-ds-service": "Users", "x-ds-in-sdk": true } }, "/v2/organizations/{organizationId}/users/{userId}/accounts": { "delete": { "tags": [ "eSignUserManagement" ], "summary": "Closes a user's memberships.", "description": "Closes a user's memberships.\n\n[Required authentication scopes](/docs/admin-api/admin101/auth/): `user_write`.\n\nThis method requires user authentication. It will fail with an [application access token](/docs/admin-api/admin101/application-auth/).", "operationId": "User_Users_CloseMembershipsV2", "consumes": [ "application/json" ], "produces": [ "application/json" ], "parameters": [ { "name": "organizationId", "in": "path", "description": "The organization ID Guid", "required": true, "type": "string", "format": "uuid" }, { "name": "userId", "in": "path", "description": "The user ID Guid", "required": true, "type": "string", "format": "uuid" }, { "name": "request", "in": "body", "description": "", "required": true, "schema": { "$ref": "#/definitions/DeleteMembershipsRequest" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/DeleteMembershipsResponse" } } }, "security": [ { "accessCode": [ "user_write" ] } ], "x-ds-methodname": "closeMemberships", "x-ds-method": "closeMemberships", "x-ds-service": "Users", "x-ds-in-sdk": true } }, "/v2/organizations/{organizationId}/users": { "get": { "tags": [ "Users" ], "summary": "Returns information about the users in an organization.", "description": "Returns information about the users in an organization.\n\nYou must include at least one of the following query parameters in the request:\n\n- `account_id`: The ID of an account associated with the organization.\n- `organization_reserved_domain_id`: The ID of one of the organization's reserved domains.\n- `email`: An email address associated with the users that you want to return.\n\n[Required authentication scopes](/docs/admin-api/admin101/auth/): `user_read`.", "operationId": "OrganizationUser_OrganizationUsers_GetV2", "produces": [ "application/json" ], "parameters": [ { "name": "organizationId", "in": "path", "description": "The organization ID Guid", "required": true, "type": "string", "format": "uuid" }, { "name": "start", "in": "query", "description": "Index of first item to include in the response. The default value is 0.", "required": false, "type": "integer", "format": "int32" }, { "name": "take", "in": "query", "description": "Page size of the response. The default value is 20.", "required": false, "type": "integer", "format": "int32" }, { "name": "end", "in": "query", "description": "Index of the last item to include in the response. Ignored if `take` parameter is specified.", "required": false, "type": "integer", "format": "int32" }, { "name": "email", "in": "query", "description": "Email address of the desired user. At least one of `email`, `account_id` or `organization_reserved_domain_id` must be specified.", "required": false, "type": "string" }, { "name": "email_user_name_like", "in": "query", "description": "Selects users by pattern matching on the user's email address", "required": false, "type": "string" }, { "name": "status", "in": "query", "description": "Status.", "required": false, "type": "string" }, { "name": "membership_status", "in": "query", "description": "The user's membership status. One of:\n\n- `activation_required`\n- `activation_sent`\n- `active`\n- `closed`\n- `disabled`\n", "required": false, "type": "string" }, { "name": "account_id", "in": "query", "description": "Select users that are members of the specified account. At least one of `email`, `account_id` or `organization_reserved_domain_id` must be specified.", "required": false, "type": "string", "format": "uuid" }, { "name": "organization_reserved_domain_id", "in": "query", "description": "Select users that are in the specified domain. At least one of `email`, `account_id` or `organization_reserved_domain_id` must be specified.", "required": false, "type": "string", "format": "uuid" }, { "name": "last_modified_since", "in": "query", "description": "Select users whose data have been modified since the date specified. `account_id` or `organization_reserved_domain_id` must be specified.", "required": false, "type": "string" }, { "name": "include_ds_groups", "in": "query", "description": "Select users with groups the users belong to; The organization must have entitlement `AllowMultiApplication` enabled.", "required": false, "type": "boolean" }, { "name": "include_license", "in": "query", "description": "", "required": false, "type": "boolean" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OrganizationUsersResponse" } } }, "security": [ { "accessCode": [ "user_read" ] } ], "x-ds-methodname": "getUsers", "x-ds-method": "getUsers", "x-ds-service": "Users", "x-ds-in-sdk": true }, "post": { "tags": [ "eSignUserManagement" ], "summary": "Creates a new eSignature user.", "description": "Creates a new eSignature user and automatically activates the user's account.\n\n[Required authentication scopes](/docs/admin-api/admin101/auth/): `user_write`.\n\n### Related topics\n\n- [How to create a new active eSignature user](/docs/admin-api/how-to/create-active-user/)\n", "operationId": "OrganizationUser_Users_AddV2", "consumes": [ "application/json" ], "produces": [ "application/json" ], "parameters": [ { "name": "organizationId", "in": "path", "description": "The organization ID Guid", "required": true, "type": "string", "format": "uuid" }, { "name": "request", "in": "body", "description": "", "required": true, "schema": { "$ref": "#/definitions/NewUserRequest" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/NewUserResponse" } } }, "security": [ { "accessCode": [ "user_write" ] } ], "x-ds-methodname": "createUser", "x-ds-method": "createUser", "x-ds-service": "Users", "x-ds-in-sdk": true } }, "/v2/organizations/{organizationId}/users/{userId}/memberships/{membershipId}": { "post": { "tags": [ "eSignUserManagement" ], "summary": "Activates user memberships.", "description": "Activates user memberships.\n\n[Required authentication scopes](/docs/admin-api/admin101/auth/): `user_write`.\n", "operationId": "OrganizationUser_Users_ActivateMembershipV2", "consumes": [ "application/json" ], "produces": [ "application/json" ], "parameters": [ { "name": "organizationId", "in": "path", "description": "The organization ID Guid", "required": true, "type": "string", "format": "uuid" }, { "name": "userId", "in": "path", "description": "The user ID Guid", "required": true, "type": "string", "format": "uuid" }, { "name": "membershipId", "in": "path", "description": "The membership ID GUID.", "required": true, "type": "string", "format": "uuid" }, { "name": "request", "in": "body", "description": "", "required": true, "schema": { "$ref": "#/definitions/ForceActivateMembershipRequest" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/UpdateResponse" } } }, "security": [ { "accessCode": [ "user_write" ] } ], "x-ds-methodname": "activateMembership", "x-ds-method": "activateMembership", "x-ds-service": "Users", "x-ds-in-sdk": true } }, "/v2/organizations/{organizationId}/users/profile": { "get": { "tags": [ "eSignUserManagement" ], "summary": "Returns historical information about users with a specific email address.\n", "description": "Returns historical information about users with a specific email address.\n**Note:** The `email` query parameter is _required_.\n\n\nTo get a list of users in an organization,\nuse [Users: getUsers](/docs/admin-api/reference/usermanagement/users/getusers/)\ninstead.\n\nFor example, the following request gets information about\naccounts that use `max@example.net` as an email address:\n\n\n```json\nGET /Management/v2/organizations/96e994fa-xxxx-xxxx-xxxx-c5fe9d1ccd10/users/profile?email=max@example.net\n\n{\n \"users\": [\n {\n \"id\": \"6b67a1ee-xxxx-xxxx-xxxx-385763624163\",\n \"site_id\": 1,\n \"site_name\": \"Monadnock\",\n \"user_name\": \"Max Example\",\n \"first_name\": \"Max\",\n \"last_name\": \"Example\",\n \"user_status\": \"active\",\n \"default_account_id\": \"f636f297-xxxx-xxxx-xxxx-8e7a14715950\",\n \"default_account_name\": \"BizCo\",\n \"is_organization_admin\": false,\n \"created_on\": \"2019-04-01T22:11:56.457\",\n \"memberships\": [\n {\n \"email\": \"max@example.net\",\n \"account_id\": \"624e3e00-xxxx-xxxx-xxxx-43918c520dab\",\n \"external_account_id\": \"17xxxxx1\",\n \"account_name\": \"LoanCo\",\n \"is_external_account\": false,\n \"status\": \"active\",\n \"permission_profile\": { },\n \"created_on\": \"2019-04-01T22:11:56.457\",\n \"groups\": [ ],\n \"is_admin\": false\n },\n {\n \"email\": \"max@example.net\",\n \"account_id\": \"f636f297-xxxx-xxxx-xxxx-8e7a14715950\",\n \"external_account_id\": \"25xxxxx0\",\n \"account_name\": \"BizCo\",\n \"is_external_account\": true,\n \"status\": \"active\",\n \"permission_profile\": { },\n \"created_on\": \"2021-07-07T15:10:51.96\",\n \"groups\": [ ],\n \"is_admin\": false\n },\n {\n \"email\": \"max@example.net\",\n \"account_id\": \"6aed3a52-xxxx-xxxx-xxxx-e89988167cfd\",\n \"external_account_id\": \"11xxxxx1\",\n \"account_name\": \"SleepCo\",\n \"is_external_account\": true,\n \"status\": \"closed\",\n \"permission_profile\": { },\n \"created_on\": \"2021-07-11T12:40:44.26\",\n \"groups\": [],\n \"is_admin\": true,\n \"closed_on\": \"2021-07-13T08:40:51.8\"\n }\n ],\n \"identities\": [],\n \"device_verification_enabled\": false\n }\n ]\n}\n```\n\nThe response includes up to the first 20 users modified in the last 10 days.\n\n[Required authentication scopes](/docs/admin-api/admin101/auth/): `user_read`.\n\n\n\n### Related topics\n\n- [How to Audit Users](/docs/admin-api/how-to/audit-users/)\n\n", "operationId": "OrganizationUser_OrganizationUsers_GetProfileV2", "produces": [ "application/json" ], "parameters": [ { "name": "organizationId", "in": "path", "description": "The organization ID Guid", "required": true, "type": "string", "format": "uuid" }, { "name": "email", "in": "query", "description": "The email address associated with the users you want to retrieve.\n\n**Note:** This property is required.", "required": false, "type": "string" }, { "name": "include_license", "in": "query", "description": "", "required": false, "type": "boolean" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/UsersDrilldownResponse" } } }, "security": [ { "accessCode": [ "user_read" ] } ], "x-ds-methodname": "getUserProfiles", "x-ds-method": "getUserProfiles", "x-ds-service": "Users", "x-ds-in-sdk": true } }, "/v2/organizations/{organizationId}/users/{userId}/identities": { "delete": { "tags": [ "eSignUserManagement" ], "summary": "Delete user identities for a specified identity provider.", "description": "Deletes all user identities linked to a specified identity provider.\n\nThe `id` request body property specifies the identity provider. To get the ID, call [getUserProfiles](/docs/admin-api/reference/usermanagement/esignusermanagement/getuserprofiles/) and copy the `provider_id` value you want to use.\n\n[Required authentication scopes](/docs/admin-api/admin101/auth/): `user_write`.\n", "operationId": "OrganizationUser_DeleteIdentitiesV2", "consumes": [ "application/json" ], "produces": [ "application/json" ], "parameters": [ { "name": "organizationId", "in": "path", "description": "The organization GUID.", "required": true, "type": "string", "format": "uuid" }, { "name": "userId", "in": "path", "description": "The ID of the user to access.", "required": true, "type": "string", "format": "uuid" }, { "name": "requestModel", "in": "body", "description": "", "required": true, "schema": { "$ref": "#/definitions/DeleteUserIdentityRequest" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/DeleteResponse" } } }, "security": [ { "accessCode": [ "user_write" ] } ], "x-ds-methodname": "deleteIdentities", "x-ds-method": "deleteIdentities", "x-ds-service": "Users", "x-ds-in-sdk": true } }, "/v2/organizations/{organizationId}/accounts/{accountId}/users": { "post": { "tags": [ "eSignUserManagement" ], "summary": "Adds users to an account.", "description": "Adds users to an account.\n\n[Required authentication scopes](/docs/admin-api/admin101/auth/): `user_write`.\n\n\n\n### Related topics\n\n- [How to create a new active eSignature user](/docs/admin-api/how-to/create-active-user/)\n", "operationId": "OrganizationUser_OrganizationUsers_PostAccountUsersV2", "consumes": [ "application/json" ], "produces": [ "application/json" ], "parameters": [ { "name": "organizationId", "in": "path", "description": "The organization ID Guid", "required": true, "type": "string", "format": "uuid" }, { "name": "accountId", "in": "path", "description": "The account ID Guid", "required": true, "type": "string", "format": "uuid" }, { "name": "request", "in": "body", "description": "", "required": true, "schema": { "$ref": "#/definitions/NewAccountUserRequest" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/NewUserResponse" } } }, "security": [ { "accessCode": [ "user_write" ] } ], "x-ds-methodname": "addUsers", "x-ds-method": "addUsers", "x-ds-service": "Users", "x-ds-in-sdk": true } }, "/v2.1/organizations/{organizationId}/accounts/{accountId}/dsgroups": { "get": { "tags": [ "MultiProductUserManagement" ], "summary": "Returns a list of DSGroups.", "description": "Returns a list of DSGroups.\n\n[Required authentication scopes](/docs/admin-api/admin101/auth/): `user_read`.\n\n\n### Related topics\n\n- [How to create a new active user for CLM and eSignature](/docs/admin-api/how-to/create-active-clm-esign-user/)", "operationId": "DocuSignGroupsv21_GetDSGroups_V2_1", "consumes": [ "application/json" ], "produces": [ "application/json" ], "parameters": [ { "name": "organizationId", "in": "path", "description": "The organization ID GUID", "required": true, "type": "string", "format": "uuid" }, { "name": "accountId", "in": "path", "description": "The account ID GUID.", "required": true, "type": "string", "format": "uuid" }, { "name": "page", "in": "query", "description": "Start page of DSGroups.", "required": false, "type": "integer", "format": "int32" }, { "name": "page_size", "in": "query", "description": "Page size of DSGroups.", "required": false, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/DSGroupListResponse" } } }, "security": [ { "accessCode": [ "user_read" ] } ], "x-ds-methodname": "getDSGroups", "x-ds-method": "getDSGroups", "x-ds-service": "DSGroups", "x-ds-in-sdk": true }, "post": { "tags": [ "MultiProductUserManagement" ], "summary": "Creates a new DSGroup.", "description": "Creates a new DSGroup.\n\n[Required authentication scopes](/docs/admin-api/admin101/auth/): `user_write`.", "operationId": "DocuSignGroupsv21_AddDSGroup_V2_1", "consumes": [ "application/json" ], "produces": [ "application/json" ], "parameters": [ { "name": "organizationId", "in": "path", "description": "The organization ID GUID", "required": true, "type": "string", "format": "uuid" }, { "name": "accountId", "in": "path", "description": "The account ID GUID.", "required": true, "type": "string", "format": "uuid" }, { "name": "addRequest", "in": "body", "description": "", "required": true, "schema": { "$ref": "#/definitions/DSGroupAddRequest" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/DSGroupResponse" } } }, "security": [ { "accessCode": [ "user_write" ] } ], "x-ds-methodname": "addDSGroup", "x-ds-method": "addDSGroup", "x-ds-service": "DSGroups", "x-ds-in-sdk": true } }, "/v2.1/organizations/{organizationId}/accounts/{accountId}/dsgroups/{dsGroupId}": { "get": { "tags": [ "MultiProductUserManagement" ], "summary": "Returns details about a single DSGroup.", "description": "Returns details about a single DSGroup.\n\n[Required authentication scopes](/docs/admin-api/admin101/auth/): `user_read`.", "operationId": "DocuSignGroupsv21_GetDSGroup_V2_1", "consumes": [ "application/json" ], "produces": [ "application/json" ], "parameters": [ { "name": "organizationId", "in": "path", "description": "The organization ID GUID", "required": true, "type": "string", "format": "uuid" }, { "name": "accountId", "in": "path", "description": "The account ID GUID.", "required": true, "type": "string", "format": "uuid" }, { "name": "dsGroupId", "in": "path", "description": "The DSGroup's ID GUID", "required": true, "type": "string", "format": "uuid" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/DSGroupResponse" } } }, "security": [ { "accessCode": [ "user_read" ] } ], "x-ds-methodname": "getDSGroup", "x-ds-method": "getDSGroup", "x-ds-service": "DSGroups", "x-ds-in-sdk": true }, "delete": { "tags": [ "MultiProductUserManagement" ], "summary": "Deletes a DSGroup.", "description": "Deletes a DSGroup.\n\n[Required authentication scopes](/docs/admin-api/admin101/auth/): `user_write`.", "operationId": "DocuSignGroupsv21_DeleteDSGroup_V2_1", "consumes": [ "application/json" ], "produces": [ "application/json" ], "parameters": [ { "name": "organizationId", "in": "path", "description": "The organization ID GUID", "required": true, "type": "string", "format": "uuid" }, { "name": "accountId", "in": "path", "description": "The account ID GUID.", "required": true, "type": "string", "format": "uuid" }, { "name": "dsGroupId", "in": "path", "description": "The DSGroup's GUID.", "required": true, "type": "string", "format": "uuid" } ], "responses": { "204": { "description": "No Content" } }, "security": [ { "accessCode": [ "user_write" ] } ], "x-ds-methodname": "deleteDSGroup", "x-ds-method": "deleteDSGroup", "x-ds-service": "DSGroups", "x-ds-in-sdk": true } }, "/v2.1/organizations/{organizationId}/accounts/{accountId}/dsgroups/{dsGroupId}/users": { "get": { "tags": [ "MultiProductUserManagement" ], "summary": "Gets a list of users in a DSGroup.", "description": "Gets a list of users in a DSGroup.\n\n[Required authentication scopes](/docs/admin-api/admin101/auth/): `user_read`.", "operationId": "DocuSignGroupsv21_GetDSGroupUsers_V2_1", "consumes": [ "application/json" ], "produces": [ "application/json" ], "parameters": [ { "name": "organizationId", "in": "path", "description": "The organization ID GUID", "required": true, "type": "string", "format": "uuid" }, { "name": "accountId", "in": "path", "description": "The account ID GUID.", "required": true, "type": "string", "format": "uuid" }, { "name": "dsGroupId", "in": "path", "description": "The DSGroup's GUID.", "required": true, "type": "string", "format": "uuid" }, { "name": "page", "in": "query", "description": "Start page of DSGroups.\n", "required": false, "type": "integer", "format": "int32" }, { "name": "page_size", "in": "query", "description": "Page size of DSGroups.", "required": false, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/DSGroupAndUsersResponse" } } }, "security": [ { "accessCode": [ "user_read" ] } ], "x-ds-methodname": "getDSGroupUsers", "x-ds-method": "getDSGroupUsers", "x-ds-service": "DSGroups", "x-ds-in-sdk": true }, "post": { "tags": [ "MultiProductUserManagement" ], "summary": "Adds a list of users to a DSGroup.", "description": "Adds a list of users to a DSGroup.\n\n[Required authentication scopes](/docs/admin-api/admin101/auth/): `user_write`.", "operationId": "DocuSignGroupsv21_AddDSGroupUsers_V2_1", "consumes": [ "application/json" ], "produces": [ "application/json" ], "parameters": [ { "name": "organizationId", "in": "path", "description": "The organization ID GUID", "required": true, "type": "string", "format": "uuid" }, { "name": "accountId", "in": "path", "description": "The account ID GUID.", "required": true, "type": "string", "format": "uuid" }, { "name": "dsGroupId", "in": "path", "description": "The DSGroup's GUID.", "required": true, "type": "string", "format": "uuid" }, { "name": "dSGroupUsersAddRequest", "in": "body", "description": "", "required": true, "schema": { "$ref": "#/definitions/DSGroupUsersAddRequest" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/AddDSGroupAndUsersResponse" } } }, "security": [ { "accessCode": [ "user_write" ] } ], "x-ds-methodname": "addDSGroupUsers", "x-ds-method": "addDSGroupUsers", "x-ds-service": "DSGroups", "x-ds-in-sdk": true }, "delete": { "tags": [ "MultiProductUserManagement" ], "summary": "Removes a list of users from a DSGroup.", "description": "Removes a list of users from a DSGroup. In the request body, you can specify users by ID or email address. If both parameters are included, the email address parameter will be ignored.\n\n[Required authentication scopes](/docs/admin-api/admin101/auth/): `user_write`.", "operationId": "DocuSignGroupsv21_RemoveDSGroupUsers_V2_1", "consumes": [ "application/json" ], "produces": [ "application/json" ], "parameters": [ { "name": "organizationId", "in": "path", "description": "The organization ID GUID", "required": true, "type": "string", "format": "uuid" }, { "name": "accountId", "in": "path", "description": "The account ID GUID.", "required": true, "type": "string", "format": "uuid" }, { "name": "dsGroupId", "in": "path", "description": "The DSGroup's GUID.", "required": true, "type": "string", "format": "uuid" }, { "name": "dSGroupUsersRemoveRequest", "in": "body", "description": "", "required": true, "schema": { "$ref": "#/definitions/DSGroupUsersRemoveRequest" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/RemoveDSGroupUsersResponse" } } }, "security": [ { "accessCode": [ "user_write" ] } ], "x-ds-methodname": "removeDSGroupUsers", "x-ds-method": "removeDSGroupUsers", "x-ds-service": "DSGroups", "x-ds-in-sdk": true } }, "/v2.1/organizations/{organizationId}/accounts/{accountId}/products/permission_profiles": { "get": { "tags": [ "MultiProductUserManagement" ], "summary": "Gets products associated with the account and the available permission profiles.", "description": "Gets products associated with the account and the available permission profiles.\n\n[Required authentication scopes](/docs/admin-api/admin101/auth/): `user_read`.\n\n\n### Related topics\n\n- [How to create a new active user for CLM and eSignature](/docs/admin-api/how-to/create-active-clm-esign-user/)", "operationId": "OrganizationProductPermissionProfile_GetProductPermissionProfiles", "consumes": [ "application/json" ], "produces": [ "application/json" ], "parameters": [ { "name": "organizationId", "in": "path", "description": "The organization ID GUID", "required": true, "type": "string", "format": "uuid" }, { "name": "accountId", "in": "path", "description": "The account ID GUID.", "required": true, "type": "string", "format": "uuid" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/ProductPermissionProfilesResponse" } } }, "security": [ { "accessCode": [ "user_read" ] } ], "x-ds-methodname": "getProductPermissionProfiles", "x-ds-method": "getProductPermissionProfiles", "x-ds-service": "ProductPermissionProfiles", "x-ds-in-sdk": true } }, "/v2.1/organizations/{organizationId}/accounts/{accountId}/products/users/{userId}/permission_profiles": { "get": { "tags": [ "MultiProductUserManagement" ], "summary": "Retrieves a user's product permission profiles by user ID.", "description": "Retrieves a list of a user's permission profiles for each account's product. The user is specified by the ID provided in the `userId` path parameter.\n\n[Required authentication scopes](/docs/admin-api/admin101/auth/): `user_read`.", "operationId": "OrganizationProductPermissionProfile_GetUserProductPermissionProfiles", "consumes": [ "application/json" ], "produces": [ "application/json" ], "parameters": [ { "name": "organizationId", "in": "path", "description": "The organization ID GUID", "required": true, "type": "string", "format": "uuid" }, { "name": "accountId", "in": "path", "description": "The account ID GUID.", "required": true, "type": "string", "format": "uuid" }, { "name": "userId", "in": "path", "description": "The user ID GUID.", "required": true, "type": "string", "format": "uuid" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/ProductPermissionProfilesResponse" } } }, "security": [ { "accessCode": [ "user_read" ] } ], "x-ds-methodname": "getUserProductPermissionProfiles", "x-ds-method": "getUserProductPermissionProfiles", "x-ds-service": "ProductPermissionProfiles", "x-ds-in-sdk": true }, "post": { "tags": [ "MultiProductUserManagement" ], "summary": "Assigns permission profiles for a user by user ID.", "description": "Sets permission profiles for one or more products for a given user. The user is specified by the `userId` path parameter.\n\n[Required authentication scopes](/docs/admin-api/admin101/auth/): `user_write`.", "operationId": "OrganizationProductPermissionProfile_PostUserProductPermissionProfiles", "consumes": [ "application/json" ], "produces": [ "application/json" ], "parameters": [ { "name": "organizationId", "in": "path", "description": "The organization ID GUID", "required": true, "type": "string", "format": "uuid" }, { "name": "accountId", "in": "path", "description": "The account ID GUID.", "required": true, "type": "string", "format": "uuid" }, { "name": "userId", "in": "path", "description": "The user ID GUID.", "required": true, "type": "string", "format": "uuid" }, { "name": "productPermissionProfilesRequest", "in": "body", "description": "", "required": true, "schema": { "$ref": "#/definitions/ProductPermissionProfilesRequest" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/UserProductPermissionProfilesResponse" } } }, "security": [ { "accessCode": [ "user_write" ] } ], "x-ds-methodname": "addUserProductPermissionProfiles", "x-ds-method": "addUserProductPermissionProfiles", "x-ds-service": "ProductPermissionProfiles", "x-ds-in-sdk": true } }, "/v2.1/organizations/{organizationId}/accounts/{accountId}/users": { "post": { "tags": [ "MultiProductUserManagement" ], "summary": "Creates or updates a multi-product user.", "description": "Creates or updates a multi-product (eSignature and CLM) user. When you use this method to create a user, the user's account is automatically activated.\n\n[Required authentication scopes](/docs/admin-api/admin101/auth/): `user_write`.\n\n### Next steps\n* Explore [an example that demonstrates how to construct the request body and call the endpoint](/docs/admin-api/how-to/create-active-clm-esign-user/).\n", "operationId": "OrganizationUser_OrganizationUsers_PostAccountUsersV2_1", "consumes": [ "application/json" ], "produces": [ "application/json" ], "parameters": [ { "name": "organizationId", "in": "path", "description": "The organization ID.", "required": true, "type": "string", "format": "uuid" }, { "name": "accountId", "in": "path", "description": "The account ID GUID.", "required": true, "type": "string", "format": "uuid" }, { "name": "request", "in": "body", "description": "", "required": true, "schema": { "$ref": "#/definitions/NewMultiProductUserAddRequest" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/AddUserResponse" } } }, "security": [ { "accessCode": [ "user_write" ] } ], "x-ds-methodname": "addOrUpdateUser", "x-ds-method": "addOrUpdateUser", "x-ds-service": "Users", "x-ds-in-sdk": true } }, "/v2.1/organizations/{organizationId}/users/dsprofile": { "get": { "tags": [ "MultiProductUserManagement" ], "summary": "Retrieves the DS profile for a user specified by email address.", "description": "Gets information about a user specified by the `email` query parameter.\n\n[Required authentication scopes](/docs/admin-api/admin101/auth/): `user_read`.", "operationId": "OrganizationUser_OrganizationUsers_GetDSProfiles", "produces": [ "application/json" ], "parameters": [ { "name": "organizationId", "in": "path", "description": "The organization's GUID.\n", "required": true, "type": "string", "format": "uuid" }, { "name": "email", "in": "query", "description": "The email address of the user.\n\n**Note:** This property is required.", "required": false, "type": "string" }, { "name": "sort", "in": "query", "description": "When **true,** sorts the results in ascending order by account name.", "required": false, "type": "boolean" }, { "name": "include_license", "in": "query", "description": "", "required": false, "type": "boolean" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/UsersDrilldownResponse" } } }, "security": [ { "accessCode": [ "user_read" ] } ], "x-ds-methodname": "getUserDSProfilesByEmail", "x-ds-method": "getUserDSProfilesByEmail", "x-ds-service": "Users", "x-ds-in-sdk": true } }, "/v2.1/organizations/{organizationId}/users/{userId}/dsprofile": { "get": { "tags": [ "MultiProductUserManagement" ], "summary": "Retrieves the DS profile for a user specified by ID.", "description": "Gets information about a user specified by the `userId` query parameter.\n\n[Required authentication scopes](/docs/admin-api/admin101/auth/): `user_read`.\n\n\n### Related topics\n\n- [How to retrieve the user's Docusign profile using an email address](/docs/admin-api/how-to/retrieve-docusign-profile-using-email/)\n- [How to retrieve the user's Docusign profile using a User ID](/docs/admin-api/how-to/retrieve-docusign-profile-using-userid/)", "operationId": "OrganizationUser_OrganizationUsers_GetDSProfileByUserId", "produces": [ "application/json" ], "parameters": [ { "name": "organizationId", "in": "path", "description": "The organization's GUID.\n", "required": true, "type": "string", "format": "uuid" }, { "name": "userId", "in": "path", "description": "The user ID GUID.", "required": true, "type": "string", "format": "uuid" }, { "name": "sort", "in": "query", "description": "When **true,** sorts the results in ascending order by account name.", "required": false, "type": "boolean" }, { "name": "include_license", "in": "query", "description": "", "required": false, "type": "boolean" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/UsersDrilldownResponse" } } }, "security": [ { "accessCode": [ "user_read" ] } ], "x-ds-methodname": "getUserDSProfile", "x-ds-method": "getUserDSProfile", "x-ds-service": "Users", "x-ds-in-sdk": true } }, "/v2.1/organizations/{organizationId}/accounts/{accountId}/products/users": { "delete": { "tags": [ "MultiProductUserManagement" ], "summary": "Revokes a user's access to one or more products.", "description": "Revokes a specified user's access to one or more products.\n\n[Required authentication scopes](/docs/admin-api/admin101/auth/): `user_write`.\n\n\n### Related topics\n\n- [How to delete user data from an account as an account admin](/docs/admin-api/how-to/account-admin-delete-user-data/)", "operationId": "OrganizationProductPermissionProfile_RemoveUserProducts", "consumes": [ "application/json" ], "produces": [ "application/json" ], "parameters": [ { "name": "organizationId", "in": "path", "description": "The organization ID GUID", "required": true, "type": "string", "format": "uuid" }, { "name": "accountId", "in": "path", "description": "The account ID GUID.", "required": true, "type": "string", "format": "uuid" }, { "name": "userProductPermissionProfilesRequest", "in": "body", "description": "", "required": true, "schema": { "$ref": "#/definitions/UserProductProfileDeleteRequest" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/RemoveUserProductsResponse" } } }, "security": [ { "accessCode": [ "user_write" ] } ], "x-ds-methodname": "removeUserProductPermission", "x-ds-method": "removeUserProductPermission", "x-ds-service": "ProductPermissionProfiles", "x-ds-in-sdk": true } }, "/v2.1/organizations/{organizationId}/accounts/{accountId}/products/permission_profiles/users": { "get": { "tags": [ "MultiProductUserManagement" ], "summary": "Retrieves a user's product permission profiles by email address.", "description": "Retrieves a list of a user's permission profiles for each account's product. The user is specified by the email address provided in the `email` query parameter.\n\n[Required authentication scopes](/docs/admin-api/admin101/auth/): `user_read`.", "operationId": "OrganizationProductPermissionProfile_GetUserProductPermissionProfilesByEmail", "consumes": [ "application/json" ], "produces": [ "application/json" ], "parameters": [ { "name": "organizationId", "in": "path", "description": "The organization ID GUID", "required": true, "type": "string", "format": "uuid" }, { "name": "accountId", "in": "path", "description": "The account ID GUID.", "required": true, "type": "string", "format": "uuid" }, { "name": "email", "in": "query", "description": "The email address of the user.\n\n**Note:** This property is required.", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/UserProductPermissionProfilesResponse" } } }, "security": [ { "accessCode": [ "user_write" ] } ], "x-ds-methodname": "getUserProductPermissionProfilesByEmail", "x-ds-method": "getUserProductPermissionProfilesByEmail", "x-ds-service": "ProductPermissionProfiles", "x-ds-in-sdk": true }, "post": { "tags": [ "MultiProductUserManagement" ], "summary": "Assigns permission profiles for a user by email address.", "description": "Sets permission profiles for one or more products for a given user. The user is specified by the `email` property in the request body.\n\n[Required authentication scopes](/docs/admin-api/admin101/auth/): `user_write`.\n\n\n### Related topics\n\n- [How to update user product permission profiles using an email address](/docs/admin-api/how-to/update-user-product-permission-profiles-using-email/)\n- [How to delete user product permission profiles using an email address](/docs/admin-api/how-to/delete-user-product-permission-profiles-using-email/)", "operationId": "OrganizationProductPermissionProfile_PostUserProductPermissionProfilesByEmail", "consumes": [ "application/json" ], "produces": [ "application/json" ], "parameters": [ { "name": "organizationId", "in": "path", "description": "The organization ID GUID", "required": true, "type": "string", "format": "uuid" }, { "name": "accountId", "in": "path", "description": "The account ID GUID.", "required": true, "type": "string", "format": "uuid" }, { "name": "userProductPermissionProfilesRequest", "in": "body", "description": "", "required": true, "schema": { "$ref": "#/definitions/UserProductPermissionProfilesRequest" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/UserProductPermissionProfilesResponse" } } }, "security": [ { "accessCode": [ "user_write" ] } ], "x-ds-methodname": "addUserProductPermissionProfilesByEmail", "x-ds-method": "addUserProductPermissionProfilesByEmail", "x-ds-service": "ProductPermissionProfiles", "x-ds-in-sdk": true } }, "/v2/organizations/{organizationId}/assetGroups/accounts": { "get": { "tags": [ "AccountCloning" ], "summary": "Get asset group accounts for an organization.", "description": "Returns a list of asset group accounts for an organization.\n\nAn asset group is a set of modules, products, plans, and charges purchased for your organization. An asset group account is an account that has been linked to an asset group.\n\nTo call this endpoint:\n* You must be an administrator for the specified organization.\n\n[Required authentication scopes](/docs/admin-api/admin101/auth/): `asset_group_account_read`.\n\n### Next steps\n* See [how to use this endpoint in your chosen programming language](/docs/admin-api/how-to/clone-account/).", "operationId": "OrganizationProvisionAssetGroup_GetAssetGroupAccountsByOrg", "consumes": [ "application/json" ], "produces": [ "application/json" ], "parameters": [ { "name": "organizationId", "in": "path", "description": "The organization's GUID.\n", "required": true, "type": "string", "format": "uuid" }, { "name": "compliant", "in": "query", "description": "When **true,** only compliant accounts are returned and account responses do not include the `compliant` field. The default value is **false.**", "required": false, "type": "boolean" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/AssetGroupAccountsResponse" } } }, "security": [ { "accessCode": [ "asset_group_account_read" ] } ], "x-ds-methodname": "getAssetGroupAccounts", "x-ds-method": "getAssetGroupAccounts", "x-ds-service": "ProvisionAssetGroup", "x-ds-in-sdk": true } }, "/v2/organizations/{organizationId}/assetGroups/accountClone": { "post": { "tags": [ "AccountCloning" ], "summary": "Clone an existing Docusign account.", "description": "Clones an existing Docusign account. Cloning an account copies the plan items and eSignature settings. Users, templates, and permission profiles are _not_ copied into the target account. The new account will linked to the same organization.\n\nIn the request body, specify the source account you are cloning by its ID. You can get the IDs for your organization's asset group accounts using the [getAssetGroupAccounts](/docs/admin-api/reference/accountprovisioning/accountcloning/getassetgroupaccounts/) endpoint. \n\nYou also need to specify information about the new target account, including the name, location, and administrator. To set the location, provide either the `countryCode` or `region` properties. (If both are specified, the `region` value will be used.) When testing in the developer environment, the region will always be `NA`.\n\nThe request body looks like this:\n```\n{\n \"sourceAccount\": {\n \"id\": \"624e3e00-xxxx-xxxx-xxxx-43918c520dab\"\n },\n \"targetAccount\": {\n \"name\": \"My Cloned Account\",\n \"admin\": {\n \"firstName\": \"Francis\",\n \"lastName\": \"Beagle\",\n \"email\": \"francis@example.com\"\n },\n \"region\": \"NA\"\n }\n}\n```\n\nTo call this endpoint:\n* You must be an administrator for the specified organization. The administrator for the target account must also be an organization admin.\n* The source account must be on the same plan as your contract.\n* The source account must be an asset group account. An asset group is a set of modules, products, plans, and charges purchased for your organization. An asset group account is an account that has been linked to an asset group.\n* Your organization must be set up for account cloning. For more information, email self-serve-provisioning-enablement@docusign.com.\n\n[Required scopes](/docs/admin-api/admin101/auth/): `asset_group_account_clone_write`.\n\n### Next steps\n* See [how to use this endpoint to clone an account](/docs/admin-api/how-to/clone-account/).", "operationId": "OrganizationProvisionAssetGroup_CloneAssetGroupAccount", "consumes": [ "application/json" ], "produces": [ "application/json" ], "parameters": [ { "name": "organizationId", "in": "path", "description": "The organization's GUID.\n", "required": true, "type": "string", "format": "uuid" }, { "name": "request", "in": "body", "description": "", "required": true, "schema": { "$ref": "#/definitions/AssetGroupAccountClone" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/AssetGroupAccountClone" } } }, "security": [ { "accessCode": [ "asset_group_account_clone_write" ] } ], "x-ds-methodname": "cloneAssetGroupAccount", "x-ds-method": "cloneAssetGroupAccount", "x-ds-service": "ProvisionAssetGroup", "x-ds-in-sdk": true } }, "/v2/organizations/{organizationId}/assetGroups/accountClones": { "get": { "tags": [ "AccountCloning" ], "summary": "Gets all asset group account clones for an organization.", "description": "Retrieves all the cloned accounts for an organization.\n\nTo call this endpoint:\n* You must be an administrator for the specified organization.\n\n[Required scopes](/docs/admin-api/admin101/auth/): `asset_group_account_clone_read`.", "operationId": "OrganizationProvisionAssetGroup_GetAssetGroupAccountClonesByOrgId", "consumes": [ "application/json" ], "produces": [ "application/json" ], "parameters": [ { "name": "organizationId", "in": "path", "description": "The organization's GUID.\n", "required": true, "type": "string", "format": "uuid" }, { "name": "since_updated_date", "in": "query", "description": "Use this parameter to retrieve only account clones that were created on or after a specified date.", "required": false, "type": "string", "format": "date-time" }, { "name": "include_details", "in": "query", "description": "When **true,** include additional details for the asset group account clones. The default value is **false.**", "required": false, "type": "boolean" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/AssetGroupAccountClones" } } }, "security": [ { "accessCode": [ "asset_group_account_clone_read" ] } ], "x-ds-methodname": "getAssetGroupAccountClonesByOrgId", "x-ds-method": "getAssetGroupAccountClonesByOrgId", "x-ds-service": "ProvisionAssetGroup", "x-ds-in-sdk": true } }, "/v2/organizations/{organizationId}/assetGroups/{assetGroupId}/accountClones/{assetGroupWorkId}": { "get": { "tags": [ "AccountCloning" ], "summary": "Gets information about a single cloned account.", "description": "Gets information about a cloned account by the `assetGroupWorkId`.\n\nTo call this endpoint:\n* You must be an administrator for the specified organization.\n\n[Required scopes](/docs/admin-api/admin101/auth/): `asset_group_account_clone_read`.", "operationId": "OrganizationProvisionAssetGroup_GetAssetGroupAccountClone", "consumes": [ "application/json" ], "produces": [ "application/json" ], "parameters": [ { "name": "organizationId", "in": "path", "description": "The organization's GUID.\n", "required": true, "type": "string", "format": "uuid" }, { "name": "assetGroupId", "in": "path", "description": "The ID of the asset group.", "required": true, "type": "string", "format": "uuid" }, { "name": "assetGroupWorkId", "in": "path", "description": "The GUID representing the asset group account clone ID.", "required": true, "type": "string", "format": "uuid" }, { "name": "include_details", "in": "query", "description": "When **true,** include additional details about the cloned account. The default value is **false.**", "required": false, "type": "boolean" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/AssetGroupAccountClone" } } }, "security": [ { "accessCode": [ "asset_group_account_clone_read" ] } ], "x-ds-methodname": "getAssetGroupAccountClone", "x-ds-method": "getAssetGroupAccountClone", "x-ds-service": "ProvisionAssetGroup", "x-ds-in-sdk": true } }, "/v2/organizations/{organizationId}/planItems": { "get": { "tags": [ "AccountCreation" ], "summary": "Get information about plan items within an organization.", "description": "Gets the plan items and subscription information for an organization.\n\n\nTo call this endpoint:\n* You must be an administrator for the specified organization\n\n[Required scopes](/docs/admin-api/admin101/auth/): `organization_sub_account_read`\n", "operationId": "OrganizationSubAccount_GetOrganizationPlanItems", "consumes": [ "application/json" ], "produces": [ "application/json" ], "parameters": [ { "name": "organizationId", "in": "path", "description": "The organization's GUID.\n", "required": true, "type": "string", "format": "uuid" } ], "responses": { "200": { "description": "OK", "schema": { "type": "array", "items": { "$ref": "#/definitions/OrganizationSubscriptionResponse" } } } }, "security": [ { "accessCode": [ "organization_sub_account_read" ] } ], "x-ds-methodname": "GetOrganizationPlanItems", "x-ds-method": "GetOrganizationPlanItems", "x-ds-service": "ProvisionAssetGroup", "x-ds-in-sdk": true } }, "/v2/organizations/{organizationId}/assetGroups/accountCreate": { "post": { "tags": [ "AccountCreation" ], "summary": "Creates a new Docusign account using the plan and modules specified in request body.", "description": "Creates a new Docusign account within an organization.\n\nIn the request body, specify the subscription and plan IDs for the new account. You can get these IDs through the [GetOrganizationPlanItems](/docs/admin-api/reference/accountprovisioning/accountcreation/getorganizationplanitems/) endpoint. \n\nYou also need to specify information about the new target account, including the name, location, and administrator. To set the location, provide the `countryCode` property. When you are testing in the developer environment, the value of `countryCode` will always be `US`.\n\nThe request body looks like this:\n\n```\n{\n \"subscriptionDetails\": {\n \"id\": \"'${SUBSCRIPTION_ID}'\",\n \"planId\": \"'${PLAN_ID}'\",\n \"modules\": []\n },\n \"targetAccount\": {\n \"name\": \"'${ACCOUNT_NAME}'\",\n \"countryCode\": \"US\",\n \"admin\": {\n \"email\": \"'${EMAIL_ADDRESS}'\",\n \"firstName\": \"'${FIRST_NAME}'\", \n \"lastName\": \"'${LAST_NAME}'\",\n \"locale\": \"en\"\n }\n }\n}\n```\n\nTo call this endpoint:\n* You must be an administrator for the specified organization.\n\n[Required scopes](/docs/admin-api/admin101/auth/): `organization_sub_account_write`", "operationId": "OrganizationSubAccount_CreateSubAccount", "consumes": [ "application/json" ], "produces": [ "application/json" ], "parameters": [ { "name": "organizationId", "in": "path", "description": "The organization's GUID.\n", "required": true, "type": "string", "format": "uuid" }, { "name": "request", "in": "body", "description": "", "required": true, "schema": { "$ref": "#/definitions/SubAccountCreateRequest" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/Subscription.Provision.Model.AssetGroupWorkResult" } } }, "security": [ { "accessCode": [ "organization_sub_account_write" ] } ], "x-ds-methodname": "CreateAssetGroupAccount", "x-ds-method": "CreateAssetGroupAccount", "x-ds-service": "ProvisionAssetGroup", "x-ds-in-sdk": true } }, "/v2/organizations/{organizationId}/subAccountsCreated": { "get": { "tags": [ "AccountCreation" ], "summary": "Get all ongoing account creation processes for an Organization.", "description": "Get ongoing account creation processes by `organizationId`.\n\n\nTo call this endpoint:\n* You must be an administrator for the specified organization\n\n[Required scopes](/docs/admin-api/admin101/auth/): `organization_sub_account_read`", "operationId": "OrganizationSubAccount_GetSubAccountCreateProcessesByOrgId", "consumes": [ "application/json" ], "produces": [ "application/json" ], "parameters": [ { "name": "organizationId", "in": "path", "description": "The organization's GUID.\n", "required": true, "type": "string", "format": "uuid" }, { "name": "since_updated_date", "in": "query", "description": "Specifies that the request will only return information for accounts that were created after the date passed in the format YYYY-MM-DD.", "required": false, "type": "string", "format": "date-time" }, { "name": "include_details", "in": "query", "description": "When `true`, include additional details about the account creation process. The default value is `false`.", "required": false, "type": "boolean" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/SubAccountCreateWorkerResponse" } } }, "security": [ { "accessCode": [ "organization_sub_account_read" ] } ], "x-ds-methodname": "GetSubAccountCreateProcessesByOrgId", "x-ds-method": "GetSubAccountCreateProcessesByOrgId", "x-ds-service": "ProvisionAssetGroup", "x-ds-in-sdk": true } }, "/v2/organizations/{organizationId}/assetGroup/{assetGroupId}/subAccountCreated/{assetGroupWorkId}": { "get": { "tags": [ "AccountCreation" ], "summary": "Get a single account creation process.", "description": "Gets information about an account creation process by the `assetGroupId`.\n\n\nTo call this endpoint:\n* You must be an administrator for the specified organization\n\n[Required scopes](/docs/admin-api/admin101/auth/): `organization_sub_account_read`", "operationId": "OrganizationSubAccount_GetSubAccountCreateProcessByAssetGroupWorkId", "consumes": [ "application/json" ], "produces": [ "application/json" ], "parameters": [ { "name": "organizationId", "in": "path", "description": "The organization's GUID.\n", "required": true, "type": "string", "format": "uuid" }, { "name": "assetGroupId", "in": "path", "description": "The ID of the asset group.", "required": true, "type": "string", "format": "uuid" }, { "name": "assetGroupWorkId", "in": "path", "description": "The ID of the asset group account clone request.", "required": true, "type": "string", "format": "uuid" }, { "name": "include_details", "in": "query", "description": "When true, include details for the asset group account clone.", "required": false, "type": "boolean" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/SubAccountCreateWorker" } } }, "security": [ { "accessCode": [ "organization_sub_account_read" ] } ], "x-ds-methodname": "GetSubAccountCreateProcessByAssetGroupWorkId", "x-ds-method": "GetSubAccountCreateProcessByAssetGroupWorkId", "x-ds-service": "ProvisionAssetGroup", "x-ds-in-sdk": true } }, "/v2/organizations/{organizationId}/connect": { "get": { "tags": [ "Connect" ], "summary": "", "description": "", "operationId": "OrganizationConnect_GetOrganizationConnectConfigs", "produces": [ "application/json" ], "parameters": [ { "name": "organizationId", "in": "path", "description": "The organization's GUID.\n", "required": true, "type": "string", "format": "uuid" }, { "name": "sortBy", "in": "query", "description": "", "required": false, "type": "string" }, { "name": "siteId", "in": "query", "description": "The site ID of the account.\n", "required": false, "type": "integer", "format": "int32" }, { "name": "accountId", "in": "query", "description": "The account ID GUID.", "required": false, "type": "string", "format": "uuid" }, { "name": "allowEnvelopePublish", "in": "query", "description": "", "required": false, "type": "boolean" }, { "name": "q", "in": "query", "description": "", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OrganizationConnectConfigsResponse" } } }, "security": [ { "accessCode": [ "connect_org_config_read_api" ] } ], "x-ds-methodname": "getOrganizationConnectConfigs", "x-ds-method": "getOrganizationConnectConfigs", "x-ds-service": "OrgConnect", "x-ds-in-sdk": true }, "post": { "tags": [ "Connect" ], "summary": "", "description": "", "operationId": "OrganizationConnect_CreateOrganizationConnectConfig", "produces": [ "application/json" ], "parameters": [ { "name": "organizationId", "in": "path", "description": "The organization's GUID.\n", "required": true, "type": "string", "format": "uuid" }, { "name": "connectRequest", "in": "body", "description": "", "required": true, "schema": { "$ref": "#/definitions/OrganizationConnectConfigurationRequest" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OrganizationConnectConfigurationDetailsResponse" } } }, "security": [ { "accessCode": [ "connect_org_config_write_api" ] } ], "x-ds-methodname": "createOrganizationConnectConfig", "x-ds-method": "createOrganizationConnectConfig", "x-ds-service": "OrgConnect", "x-ds-in-sdk": true } }, "/v2/organizations/{organizationId}/connect/{connectId}": { "get": { "tags": [ "Connect" ], "summary": "", "description": "", "operationId": "OrganizationConnect_GetOrganizationConnectConfig", "produces": [ "application/json" ], "parameters": [ { "name": "organizationId", "in": "path", "description": "The organization's GUID.\n", "required": true, "type": "string", "format": "uuid" }, { "name": "connectId", "in": "path", "description": "", "required": true, "type": "string", "format": "uuid" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OrganizationConnectConfigurationDetailsResponse" } } }, "security": [ { "accessCode": [ "connect_org_config_read_api" ] } ], "x-ds-methodname": "getOrganizationConnectConfig", "x-ds-method": "getOrganizationConnectConfig", "x-ds-service": "OrgConnect", "x-ds-in-sdk": true }, "delete": { "tags": [ "Connect" ], "summary": "", "description": "", "operationId": "OrganizationConnect_DeleteOrganizationConnectConfig", "produces": [ "application/json" ], "parameters": [ { "name": "organizationId", "in": "path", "description": "The organization's GUID.\n", "required": true, "type": "string", "format": "uuid" }, { "name": "connectId", "in": "path", "description": "", "required": true, "type": "string", "format": "uuid" } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "accessCode": [ "connect_org_config_write_api" ] } ], "x-ds-methodname": "deleteOrganizationConnectConfig", "x-ds-method": "deleteOrganizationConnectConfig", "x-ds-service": "OrgConnect", "x-ds-in-sdk": true }, "put": { "tags": [ "Connect" ], "summary": "", "description": "", "operationId": "OrganizationConnect_UpdateOrganizationConnectConfig", "produces": [ "application/json" ], "parameters": [ { "name": "organizationId", "in": "path", "description": "The organization's GUID.\n", "required": true, "type": "string", "format": "uuid" }, { "name": "connectId", "in": "path", "description": "", "required": true, "type": "string", "format": "uuid" }, { "name": "connectRequest", "in": "body", "description": "", "required": true, "schema": { "$ref": "#/definitions/OrganizationConnectConfigurationRequest" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OrganizationConnectConfigurationDetailsResponse" } } }, "security": [ { "accessCode": [ "connect_org_config_write_api" ] } ], "x-ds-methodname": "updateOrganizationConnectConfig", "x-ds-method": "updateOrganizationConnectConfig", "x-ds-service": "OrgConnect", "x-ds-in-sdk": true } }, "/v2/organizations/{organizationId}/connect/oauth": { "delete": { "tags": [ "Connect" ], "summary": "", "description": "", "operationId": "OrganizationConnectOAuthConfiguration_DeleteOrganizationConnectOAuthConfiguration", "produces": [ "application/json" ], "parameters": [ { "name": "organizationId", "in": "path", "description": "The organization's GUID.\n", "required": true, "type": "string", "format": "uuid" } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "accessCode": [ "connect_org_oauth_write_api" ] } ], "x-ds-methodname": "deleteOrganizationConnectOAuthConfiguration", "x-ds-method": "deleteOrganizationConnectOAuthConfiguration", "x-ds-service": "OrgConnect", "x-ds-in-sdk": true }, "get": { "tags": [ "Connect" ], "summary": "", "description": "", "operationId": "OrganizationConnectOAuthConfiguration_GetOrganizationConnectOAuthConfiguration", "produces": [ "application/json" ], "parameters": [ { "name": "organizationId", "in": "path", "description": "The organization's GUID.\n", "required": true, "type": "string", "format": "uuid" } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "accessCode": [ "connect_org_oauth_read_api" ] } ], "x-ds-methodname": "getOrganizationConnectOAuthConfiguration", "x-ds-method": "getOrganizationConnectOAuthConfiguration", "x-ds-service": "OrgConnect", "x-ds-in-sdk": true }, "post": { "tags": [ "Connect" ], "summary": "", "description": "", "operationId": "OrganizationConnectOAuthConfiguration_PostOrganizationConnectOAuthConfiguration", "produces": [ "application/json" ], "parameters": [ { "name": "organizationId", "in": "path", "description": "The organization's GUID.\n", "required": true, "type": "string", "format": "uuid" }, { "name": "configuration", "in": "body", "description": "", "required": true, "schema": { "$ref": "#/definitions/OrganizationConnectOAuthConfiguration" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OrganizationConnectOAuthConfiguration" } } }, "security": [ { "accessCode": [ "connect_org_oauth_write_api" ] } ], "x-ds-methodname": "postOrganizationConnectOAuthConfiguration", "x-ds-method": "postOrganizationConnectOAuthConfiguration", "x-ds-service": "OrgConnect", "x-ds-in-sdk": true }, "put": { "tags": [ "Connect" ], "summary": "", "description": "", "operationId": "OrganizationConnectOAuthConfiguration_PutOrganizationConnectOAuthConfiguration", "produces": [ "application/json" ], "parameters": [ { "name": "organizationId", "in": "path", "description": "The organization's GUID.\n", "required": true, "type": "string", "format": "uuid" }, { "name": "configuration", "in": "body", "description": "", "required": true, "schema": { "$ref": "#/definitions/OrganizationConnectOAuthConfiguration" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OrganizationConnectOAuthConfiguration" } } }, "security": [ { "accessCode": [ "connect_org_oauth_write_api" ] } ], "x-ds-methodname": "putOrganizationConnectOAuthConfiguration", "x-ds-method": "putOrganizationConnectOAuthConfiguration", "x-ds-service": "OrgConnect", "x-ds-in-sdk": true } }, "/v2/organizations/{organizationId}/connect/secret": { "get": { "tags": [ "Connect" ], "summary": "", "description": "", "operationId": "OrganizationConnectHmac_GetConnectHmacSecrets", "produces": [ "application/json" ], "parameters": [ { "name": "organizationId", "in": "path", "description": "The organization's GUID.\n", "required": true, "type": "string", "format": "uuid" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OrganizationConnectHmacSecretsResponse" } } }, "security": [ { "accessCode": [ "connect_org_hmac_read_api" ] } ], "x-ds-methodname": "getConnectHmacSecrets", "x-ds-method": "getConnectHmacSecrets", "x-ds-service": "OrgConnect", "x-ds-in-sdk": true }, "post": { "tags": [ "Connect" ], "summary": "", "description": "", "operationId": "OrganizationConnectHmac_PostConnectHmacSecret", "produces": [ "application/json" ], "parameters": [ { "name": "organizationId", "in": "path", "description": "The organization's GUID.\n", "required": true, "type": "string", "format": "uuid" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OrganizationConnectHmacSecretsResponse" } } }, "security": [ { "accessCode": [ "connect_org_hmac_write_api" ] } ], "x-ds-methodname": "postConnectHmacSecret", "x-ds-method": "postConnectHmacSecret", "x-ds-service": "OrgConnect", "x-ds-in-sdk": true } }, "/v2/organizations/{organizationId}/connect/secret/{keyId}": { "delete": { "tags": [ "Connect" ], "summary": "", "description": "", "operationId": "OrganizationConnectHmac_DeleteConnectHmacSecret", "produces": [ "application/json" ], "parameters": [ { "name": "organizationId", "in": "path", "description": "The organization's GUID.\n", "required": true, "type": "string", "format": "uuid" }, { "name": "keyId", "in": "path", "description": "", "required": true, "type": "string", "format": "uuid" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OrganizationConnectHmacSecretsResponse" } } }, "security": [ { "accessCode": [ "connect_org_hmac_write_api" ] } ], "x-ds-methodname": "deleteConnectHmacSecret", "x-ds-method": "deleteConnectHmacSecret", "x-ds-service": "OrgConnect", "x-ds-in-sdk": true } } }, "definitions": { "AssetGroupAccountsResponse": { "type": "object", "properties": { "assetGroupAccounts": { "description": "The list of asset group accounts.", "type": "array", "items": { "$ref": "#/definitions/AssetGroupAccountResponse" }, "readOnly": true } }, "x-ds-definition-name": "AssetGroupAccountsResponse", "description": "A list of asset group accounts.", "x-ms-summary": "A list of asset group accounts." }, "AssetGroupAccountResponse": { "type": "object", "properties": { "assetGroupId": { "format": "uuid", "description": "The asset group ID.", "type": "string", "readOnly": true, "example": "00000000-0000-0000-0000-000000000000" }, "assetGroupName": { "description": "Reserved for Docusign.", "type": "string", "readOnly": true }, "accountId": { "format": "uuid", "description": "The ID of the account.", "type": "string", "readOnly": true, "example": "00000000-0000-0000-0000-000000000000" }, "accountName": { "description": "The name of the account.", "type": "string", "readOnly": true }, "externalAccountId": { "format": "int64", "description": "The external account ID.\n", "type": "integer", "readOnly": true }, "compliant": { "description": "When **true,** indicates that the account is compliant.", "type": "boolean", "readOnly": true }, "siteId": { "format": "int32", "description": "Reserved for Docusign.", "type": "integer", "readOnly": true }, "siteName": { "description": "Reserved for Docusign.", "type": "string", "readOnly": true } }, "x-ds-definition-name": "AssetGroupAccountResponse", "description": "", "x-ms-summary": "" }, "AssetGroupAccountClone": { "required": [ "sourceAccount", "targetAccount" ], "type": "object", "properties": { "sourceAccount": { "$ref": "#/definitions/AssetGroupAccountCloneSourceAccount", "description": "The source account that is cloned." }, "targetAccount": { "$ref": "#/definitions/AssetGroupAccountCloneTargetAccount", "description": "The target account that is created." }, "assetGroupWorkId": { "format": "uuid", "description": "The ID of the job that is created by the request. Use this value to retrieve information about the clone request with the [getAssetGroupAccountClone](/docs/admin-api/reference/accountprovisioning/accountcloning/getassetgroupaccountclone/) endpoint.\n\nThis property is read-only.", "type": "string", "readOnly": true, "example": "00000000-0000-0000-0000-000000000000" }, "assetGroupId": { "format": "uuid", "description": "The ID of the asset group to which the account belongs. Use this value to retrieve information about the clone request with the [getAssetGroupAccountClone](/docs/admin-api/reference/accountprovisioning/accountcloning/getassetgroupaccountclone/) endpoint.\n\nThis property is read-only.", "type": "string", "readOnly": true, "example": "00000000-0000-0000-0000-000000000000" }, "assetGroupWorkType": { "description": "The type of asset group work. This property is read-only.", "enum": [ "Undefined", "GroupAssetFulfillment", "AccountAssetFulfillment", "AccountAssetClone", "AccountAssetCreate", "SubscriptionSync" ], "type": "string", "readOnly": true }, "status": { "description": "The status of the clone request. Valid values:\n* `Pending`\n* `Processing`\n* `PendingError`\n* `ProcessingError`\n* `Completed`\n* `Canceled`\n* `PermanentFailure`\n\nThis property is read-only.", "enum": [ "Undefined", "Pending", "Processing", "ProcessingOnHold", "PendingError", "ProcessingError", "Completed", "Canceled", "PermanentFailure" ], "type": "string", "readOnly": true }, "cloneRequestId": { "format": "uuid", "description": "Reserved for Docusign.", "type": "string", "readOnly": true, "example": "00000000-0000-0000-0000-000000000000" }, "orderId": { "format": "uuid", "description": "Reserved for Docusign.", "type": "string", "readOnly": true, "example": "00000000-0000-0000-0000-000000000000" }, "attempts": { "format": "int32", "description": "The number of retries. This property is read-only.", "type": "integer", "readOnly": true }, "createdDate": { "format": "date-time", "description": "The date that the clone request was initiated. This property is read-only.", "type": "string", "readOnly": true }, "createdByName": { "description": "The name of the user who initiated the clone request. This property is read-only.", "type": "string", "readOnly": true }, "createdByEmail": { "description": "The email address of the user who initiated the clone request. This property is read-only.", "type": "string", "readOnly": true }, "message": { "description": "A message providing information about the clone request. If the request resulted in an error, this message includes specific information about the error.\n\nThis property is read-only.", "type": "string", "readOnly": true }, "cloneProcessingFailureDetails": { "$ref": "#/definitions/SubAccountErrorDetails", "description": "The processing failures if the work is in `PendingError` or `ProcessingError` status. This property is read-only.", "readOnly": true } }, "x-ds-definition-name": "AssetGroupAccountClone", "description": "The account that is cloned.", "x-ms-summary": "The account that is cloned." }, "AssetGroupAccountCloneSourceAccount": { "required": [ "id" ], "type": "object", "properties": { "id": { "format": "uuid", "description": "The ID of the account to clone. This property is required in POST requests.\n", "type": "string", "example": "00000000-0000-0000-0000-000000000000" }, "externalAccountId": { "format": "int64", "description": "The external account ID of the source account.\n", "type": "integer", "readOnly": true }, "site": { "description": "The site the source account is on.", "type": "string", "readOnly": true }, "name": { "description": "The name of the source account.", "type": "string", "readOnly": true } }, "x-ds-definition-name": "AssetGroupAccountCloneSourceAccount", "description": "", "x-ms-summary": "" }, "AssetGroupAccountCloneTargetAccount": { "type": "object", "properties": { "id": { "format": "uuid", "description": "The ID of the target account. This property is read-only.", "type": "string", "example": "00000000-0000-0000-0000-000000000000" }, "name": { "description": "The name of the target account. This property is required in the request body when cloning an account.", "type": "string" }, "region": { "description": "The region of the target account. When testing in the developer environment, the region will always be `NA`.\n\n**Note:** When cloning an account, you must include this property or `countryCode` in the request. If both are provided, `region` will be used.", "type": "string" }, "countryCode": { "description": "The two-letter [ISO 3166](https://en.wikipedia.org/wiki/List_of_ISO_3166_country_codes) country code of the target account.\n\n**Note:** When cloning an account, you must include this property or `region`. If both are provided, `region` will be used.", "type": "string" }, "site": { "description": "The data center site of the account. This property is read-only.", "type": "string" }, "admin": { "$ref": "#/definitions/AssetGroupAccountCloneTargetAccountAdmin", "description": "The administrator of the new account. This property is required in the request body when cloning an account." } }, "x-ds-definition-name": "AssetGroupAccountCloneTargetAccount", "description": "An object describing the target cloned account.", "x-ms-summary": "An object describing the target cloned account." }, "AssetGroupAccountCloneTargetAccountAdmin": { "type": "object", "properties": { "email": { "description": "The email address of the target account administrator. This property is required in the request body when cloning an account.", "type": "string" }, "firstName": { "description": "The first name of the target account administrator. This property is required in the request body when cloning an account.", "type": "string" }, "lastName": { "description": "The last name of the target account administrator. This property is required in the request body when cloning an account.", "type": "string" }, "locale": { "description": "The locale of the target account administrator. The locale code for the United States is `en`.", "enum": [ "None", "zh_cn", "zh_tw", "nl", "en", "fr", "de", "it", "ja", "ko", "pt", "pt_br", "ru", "es", "pl" ], "type": "string" } }, "x-ds-definition-name": "AssetGroupAccountCloneTargetAccountAdmin", "description": "An object describing the administrator of the cloned account.", "x-ms-summary": "An object describing the administrator of the cloned account." }, "SubAccountErrorDetails": { "type": "object", "properties": { "error": { "description": "The error code.", "type": "string", "readOnly": true }, "errorDescription": { "description": "The error description.", "type": "string", "readOnly": true }, "isSystemError": { "description": "Whether the error is caused by the system or user.", "type": "boolean", "readOnly": true } }, "x-ds-definition-name": "SubAccountErrorDetails", "description": "", "x-ms-summary": "" }, "AssetGroupAccountClones": { "type": "object", "properties": { "assetGroupWorks": { "description": "The list of asset group accounts.", "type": "array", "items": { "$ref": "#/definitions/AssetGroupAccountClone" }, "readOnly": true } }, "x-ds-definition-name": "AssetGroupAccountClones", "description": "", "x-ms-summary": "" }, "OrganizationSubscriptionResponse": { "type": "object", "properties": { "plan_id": { "format": "uuid", "type": "string", "example": "00000000-0000-0000-0000-000000000000", "description": "" }, "plan_name": { "type": "string", "description": "" }, "associated_accounts_count": { "format": "int32", "type": "integer", "description": "" }, "asset_group_name": { "type": "string", "description": "" }, "asset_group_id": { "format": "uuid", "type": "string", "example": "00000000-0000-0000-0000-000000000000", "description": "" }, "subscription_name": { "type": "string", "description": "" }, "subscription_id": { "type": "string", "description": "" }, "modules": { "type": "array", "items": { "$ref": "#/definitions/SubscriptionPlanItemResponse" }, "description": "List of module IDs selected for creating the new account" } }, "x-ds-definition-name": "OrganizationSubscriptionResponse", "description": "", "x-ms-summary": "" }, "SubscriptionPlanItemResponse": { "type": "object", "properties": { "plan_item_id": { "format": "uuid", "type": "string", "example": "00000000-0000-0000-0000-000000000000", "description": "" }, "plan_item_name": { "type": "string", "description": "" }, "plan_item_description": { "type": "string", "description": "" }, "plan_item_internal_id": { "type": "string", "description": "" } }, "x-ds-definition-name": "SubscriptionPlanItemResponse", "description": "", "x-ms-summary": "" }, "SubAccountCreateRequest": { "type": "object", "properties": { "subscriptionDetails": { "$ref": "#/definitions/SubAccountCreateRequest.SubAccountCreationSubscription", "description": "The subscription info for the new account." }, "targetAccount": { "$ref": "#/definitions/SubAccountCreateRequest.SubAccountCreationTargetAccountDetails", "description": "The target account to clone to." } }, "x-ds-definition-name": "SubAccountCreateRequest", "description": "", "x-ms-summary": "" }, "SubAccountCreateRequest.SubAccountCreationSubscription": { "type": "object", "properties": { "id": { "type": "string", "description": "" }, "planId": { "format": "uuid", "type": "string", "example": "00000000-0000-0000-0000-000000000000", "description": "Plan ID" }, "modules": { "type": "array", "items": { "format": "uuid", "type": "string", "example": "00000000-0000-0000-0000-000000000000" }, "description": "List of module IDs selected for creating the new account" } }, "x-ds-definition-name": "SubAccountCreateRequest.SubAccountCreationSubscription", "description": "", "x-ms-summary": "" }, "SubAccountCreateRequest.SubAccountCreationTargetAccountDetails": { "type": "object", "properties": { "id": { "type": "string", "description": "" }, "address": { "$ref": "#/definitions/AddressInformation", "description": "" }, "admin": { "$ref": "#/definitions/SubAccountCreateRequest.SubAccountCreationTargetAccountAdmin", "description": "The admin user for the target account." }, "name": { "type": "string", "description": "" }, "countryCode": { "type": "string", "description": "The country code where the target account is in. This value is ignored if region is provided." }, "region": { "type": "string", "description": "The region where the target account is in." }, "site": { "type": "string", "description": "The site where the target account is on." } }, "x-ds-definition-name": "SubAccountCreateRequest.SubAccountCreationTargetAccountDetails", "description": "", "x-ms-summary": "" }, "AddressInformation": { "type": "object", "properties": { "street_address": { "type": "string", "description": "" }, "street_address_2": { "type": "string", "description": "" }, "locality": { "type": "string", "description": "" }, "region": { "type": "string", "description": "The region where the target account is in." }, "postal_code": { "type": "string", "description": "" }, "country": { "type": "string", "description": "" }, "phone": { "type": "string", "description": "" }, "fax": { "type": "string", "description": "" } }, "x-ds-definition-name": "AddressInformation", "description": "", "x-ms-summary": "" }, "SubAccountCreateRequest.SubAccountCreationTargetAccountAdmin": { "type": "object", "properties": { "address": { "$ref": "#/definitions/AddressInformation", "description": "" }, "email": { "type": "string", "description": "The email address." }, "firstName": { "type": "string", "description": "" }, "lastName": { "type": "string", "description": "" }, "locale": { "enum": [ "None", "zh_cn", "zh_tw", "nl", "en", "fr", "de", "it", "ja", "ko", "pt", "pt_br", "ru", "es", "pl" ], "type": "string", "description": "" } }, "x-ds-definition-name": "SubAccountCreateRequest.SubAccountCreationTargetAccountAdmin", "description": "", "x-ms-summary": "" }, "Subscription.Provision.Model.AssetGroupWorkResult": { "type": "object", "properties": { "AssetGroupWork": { "$ref": "#/definitions/Subscription.Provision.Model.AssetGroupWork", "description": "" }, "Message": { "type": "string", "readOnly": true, "description": "" }, "Success": { "type": "boolean", "readOnly": true, "description": "" } }, "x-ds-definition-name": "Subscription.Provision.Model.AssetGroupWorkResult", "description": "", "x-ms-summary": "" }, "Subscription.Provision.Model.AssetGroupWork": { "type": "object", "properties": { "AssetGroupWorkId": { "format": "uuid", "type": "string", "example": "00000000-0000-0000-0000-000000000000", "description": "" }, "AssetGroupId": { "format": "uuid", "type": "string", "example": "00000000-0000-0000-0000-000000000000", "description": "" }, "AssetGroupWorkType": { "enum": [ "Undefined", "GroupAssetFulfillment", "AccountAssetFulfillment", "AccountAssetClone", "AccountAssetCreate", "SubscriptionSync" ], "type": "string", "description": "" }, "Status": { "enum": [ "Undefined", "Pending", "Processing", "ProcessingOnHold", "PendingError", "ProcessingError", "Completed", "Canceled", "PermanentFailure" ], "type": "string", "description": "" }, "OrderId": { "format": "uuid", "type": "string", "example": "00000000-0000-0000-0000-000000000000", "description": "" }, "TargetAccountId": { "format": "uuid", "type": "string", "example": "00000000-0000-0000-0000-000000000000", "description": "" }, "SourceAccountId": { "format": "uuid", "type": "string", "example": "00000000-0000-0000-0000-000000000000", "description": "" }, "SourceAccountExternalId": { "format": "int64", "type": "integer", "description": "" }, "SourceAccountName": { "type": "string", "description": "" }, "SourceAccountSite": { "type": "string", "description": "" }, "CloneRequestId": { "format": "uuid", "type": "string", "example": "00000000-0000-0000-0000-000000000000", "description": "" }, "CloneAccountDetails": { "$ref": "#/definitions/Subscription.Provision.Model.Account.Create.CreateAccountDetails", "description": "" }, "CreateSubAccountDetails": { "$ref": "#/definitions/Subscription.Provision.Model.Account.Create.CreateSubAccountDetails", "description": "" }, "Attempts": { "format": "int32", "type": "integer", "description": "" }, "RetryOn": { "format": "date-time", "type": "string", "description": "" }, "Message": { "type": "string", "description": "" }, "CreatedByName": { "type": "string", "description": "" }, "CreatedByEmail": { "type": "string", "description": "" }, "ErrorDetails": { "$ref": "#/definitions/Subscription.Provision.Model.ServiceErrorDetails", "description": "" }, "OldAssetGroupSubscriptionId": { "format": "uuid", "type": "string", "example": "00000000-0000-0000-0000-000000000000", "description": "" }, "NewAssetGroupSubscriptionId": { "format": "uuid", "type": "string", "example": "00000000-0000-0000-0000-000000000000", "description": "" }, "SourceSystem": { "type": "string", "description": "" }, "SourceId": { "type": "string", "description": "" }, "CreatedBy": { "type": "string", "description": "" }, "CreatedByType": { "enum": [ 0, 1, 2, 3, 4, 5 ], "description": "", "format": "int32", "type": "integer" }, "CreatedDate": { "format": "date-time", "type": "string", "description": "" }, "UpdatedBy": { "type": "string", "description": "" }, "UpdatedByType": { "enum": [ 0, 1, 2, 3, 4, 5 ], "description": "", "format": "int32", "type": "integer" }, "UpdatedDate": { "format": "date-time", "type": "string", "description": "" }, "UpdateHistory": { "type": "array", "items": { "$ref": "#/definitions/Subscription.Provision.Model.ChangeEvent" }, "description": "" } }, "x-ds-definition-name": "Subscription.Provision.Model.AssetGroupWork", "description": "", "x-ms-summary": "" }, "Subscription.Provision.Model.Account.Create.CreateAccountDetails": { "type": "object", "properties": { "Name": { "type": "string", "description": "" }, "CountryCode": { "type": "string", "description": "" }, "Region": { "type": "string", "description": "" }, "Site": { "type": "string", "description": "" }, "Address": { "$ref": "#/definitions/DocuSign.Account.Domain.Model.Address", "description": "" }, "AdminUser": { "$ref": "#/definitions/Subscription.Provision.Model.Account.Create.AccountAdmin", "description": "" }, "BillingProfileType": { "enum": [ 0, 1 ], "description": "", "format": "int32", "type": "integer" } }, "x-ds-definition-name": "Subscription.Provision.Model.Account.Create.CreateAccountDetails", "description": "", "x-ms-summary": "" }, "Subscription.Provision.Model.Account.Create.CreateSubAccountDetails": { "type": "object", "properties": { "SubscriptionDetails": { "$ref": "#/definitions/Subscription.Provision.Model.Account.Create.CreateAccountSubscriptionDetails", "description": "" }, "Name": { "type": "string", "description": "" }, "CountryCode": { "type": "string", "description": "" }, "Region": { "type": "string", "description": "" }, "Site": { "type": "string", "description": "" }, "Address": { "$ref": "#/definitions/DocuSign.Account.Domain.Model.Address", "description": "" }, "AdminUser": { "$ref": "#/definitions/Subscription.Provision.Model.Account.Create.AccountAdmin", "description": "" }, "BillingProfileType": { "enum": [ 0, 1 ], "description": "", "format": "int32", "type": "integer" } }, "x-ds-definition-name": "Subscription.Provision.Model.Account.Create.CreateSubAccountDetails", "description": "", "x-ms-summary": "" }, "Subscription.Provision.Model.ServiceErrorDetails": { "type": "object", "properties": { "ErrorCode": { "type": "string", "description": "" }, "PublicErrorCode": { "type": "string", "description": "" }, "ErrorDescription": { "type": "string", "description": "" }, "IsSystemError": { "type": "boolean", "description": "" } }, "x-ds-definition-name": "Subscription.Provision.Model.ServiceErrorDetails", "description": "", "x-ms-summary": "" }, "Subscription.Provision.Model.ChangeEvent": { "type": "object", "properties": { "EventDate": { "format": "date-time", "type": "string", "description": "" }, "Action": { "type": "string", "description": "" }, "TraceToken": { "format": "uuid", "type": "string", "example": "00000000-0000-0000-0000-000000000000", "description": "" } }, "x-ds-definition-name": "Subscription.Provision.Model.ChangeEvent", "description": "", "x-ms-summary": "" }, "DocuSign.Account.Domain.Model.Address": { "type": "object", "properties": { "Address1": { "type": "string", "description": "" }, "Address2": { "type": "string", "description": "" }, "City": { "type": "string", "description": "" }, "StateProvince": { "type": "string", "description": "" }, "Country": { "type": "string", "description": "" }, "PostalCode": { "type": "string", "description": "" }, "Phone": { "type": "string", "description": "" }, "Fax": { "type": "string", "description": "" }, "ZipPlus4": { "type": "string", "description": "" } }, "x-ds-definition-name": "DocuSign.Account.Domain.Model.Address", "description": "", "x-ms-summary": "" }, "Subscription.Provision.Model.Account.Create.AccountAdmin": { "type": "object", "properties": { "EmailAddress": { "type": "string", "description": "" }, "FirstName": { "type": "string", "description": "" }, "LastName": { "type": "string", "description": "" }, "Locale": { "enum": [ "None", "zh_cn", "zh_tw", "nl", "en", "fr", "de", "it", "ja", "ko", "pt", "pt_br", "ru", "es", "pl" ], "type": "string", "description": "" }, "Address": { "$ref": "#/definitions/DocuSign.Account.Domain.Model.Address", "description": "" } }, "x-ds-definition-name": "Subscription.Provision.Model.Account.Create.AccountAdmin", "description": "", "x-ms-summary": "" }, "Subscription.Provision.Model.Account.Create.CreateAccountSubscriptionDetails": { "type": "object", "properties": { "SubscriptionId": { "type": "string", "description": "" }, "PlanId": { "format": "uuid", "type": "string", "example": "00000000-0000-0000-0000-000000000000", "description": "" }, "Modules": { "type": "array", "items": { "format": "uuid", "type": "string", "example": "00000000-0000-0000-0000-000000000000" }, "description": "" } }, "x-ds-definition-name": "Subscription.Provision.Model.Account.Create.CreateAccountSubscriptionDetails", "description": "", "x-ms-summary": "" }, "SubAccountCreateWorkerResponse": { "type": "object", "properties": { "assetGroupWorks": { "description": "The list of asset group accounts.", "type": "array", "items": { "$ref": "#/definitions/SubAccountCreateWorker" }, "readOnly": true } }, "x-ds-definition-name": "SubAccountCreateWorkerResponse", "description": "", "x-ms-summary": "" }, "SubAccountCreateWorker": { "required": [ "targetAccount", "subscriptionDetails" ], "type": "object", "properties": { "targetAccount": { "$ref": "#/definitions/SubAccountCreateTargetAccount", "description": "The target account to clone to." }, "subscriptionDetails": { "$ref": "#/definitions/SubAccountCreateSubscriptionDetails", "description": "The subscription info for the new account." }, "assetGroupWorkId": { "format": "uuid", "description": "The ID of the job that is created by the request.", "type": "string", "readOnly": true, "example": "00000000-0000-0000-0000-000000000000" }, "assetGroupId": { "format": "uuid", "description": "The ID of the asset group to which the accounts belong.", "type": "string", "readOnly": true, "example": "00000000-0000-0000-0000-000000000000" }, "assetGroupWorkType": { "description": "The type of asset group work. This property is read-only.", "enum": [ "Undefined", "GroupAssetFulfillment", "AccountAssetFulfillment", "AccountAssetClone", "AccountAssetCreate", "SubscriptionSync" ], "type": "string", "readOnly": true }, "status": { "description": "The status of the account creation request.", "enum": [ "Undefined", "Pending", "Processing", "ProcessingOnHold", "PendingError", "ProcessingError", "Completed", "Canceled", "PermanentFailure" ], "type": "string", "readOnly": true }, "orderId": { "format": "uuid", "description": "The order ID created by the clone work.\n", "type": "string", "readOnly": true, "example": "00000000-0000-0000-0000-000000000000" }, "attempts": { "format": "int32", "description": "The number of times the job has been attempted.", "type": "integer", "readOnly": true }, "createdDate": { "format": "date-time", "description": "The date the account clone work is created.", "type": "string", "readOnly": true }, "createdByName": { "description": "The name of the creator of the account clone work.", "type": "string", "readOnly": true }, "createdByEmail": { "description": "The email of the creator of the account clone work.", "type": "string", "readOnly": true }, "message": { "description": "The message associated with the account clone work.", "type": "string", "readOnly": true }, "createAccountProcessingFailureDetails": { "$ref": "#/definitions/SubAccountErrorDetails", "description": "The processing failure details if the job has a status of `PendingError` or `ProcessingError`.", "readOnly": true } }, "x-ds-definition-name": "SubAccountCreateWorker", "description": "", "x-ms-summary": "" }, "SubAccountCreateTargetAccount": { "type": "object", "properties": { "id": { "format": "uuid", "description": "The account ID of the new account. The GUID will be empty if the account has not been created yet.", "type": "string", "example": "00000000-0000-0000-0000-000000000000" }, "name": { "description": "The name of the target account.", "type": "string" }, "region": { "description": "The region where the target account is in.", "type": "string" }, "countryCode": { "description": "The country code where the target account is in. This value is ignored if region is provided.", "type": "string" }, "site": { "description": "The site where the target account is on.", "type": "string" }, "admin": { "$ref": "#/definitions/SubAccountCreateTargetAccountAdmin", "description": "The admin user for the target account." } }, "x-ds-definition-name": "SubAccountCreateTargetAccount", "description": "", "x-ms-summary": "" }, "SubAccountCreateSubscriptionDetails": { "type": "object", "properties": { "id": { "description": "Subscription ID", "type": "string" }, "planId": { "format": "uuid", "description": "Plan ID", "type": "string", "example": "00000000-0000-0000-0000-000000000000" }, "planName": { "description": "Plan name", "type": "string" }, "modules": { "description": "List of module IDs selected for creating the new account", "type": "array", "items": { "$ref": "#/definitions/SubAccountCreateSubscriptionModuleDetails" } } }, "x-ds-definition-name": "SubAccountCreateSubscriptionDetails", "description": "", "x-ms-summary": "" }, "SubAccountCreateTargetAccountAdmin": { "type": "object", "properties": { "email": { "description": "The email address of the target account's admin user.", "type": "string" }, "firstName": { "description": "", "type": "string" }, "lastName": { "description": "", "type": "string" }, "locale": { "description": "", "enum": [ "None", "zh_cn", "zh_tw", "nl", "en", "fr", "de", "it", "ja", "ko", "pt", "pt_br", "ru", "es", "pl" ], "type": "string" } }, "x-ds-definition-name": "SubAccountCreateTargetAccountAdmin", "description": "", "x-ms-summary": "" }, "SubAccountCreateSubscriptionModuleDetails": { "type": "object", "properties": { "moduleId": { "format": "uuid", "description": "Module ID", "type": "string", "example": "00000000-0000-0000-0000-000000000000" }, "moduleName": { "description": "Module name", "type": "string" } }, "x-ds-definition-name": "SubAccountCreateSubscriptionModuleDetails", "description": "", "x-ms-summary": "" }, "OrganizationsResponse": { "type": "object", "properties": { "organizations": { "type": "array", "items": { "$ref": "#/definitions/OrganizationResponse" }, "description": "A list of organizations of which the authenticated user is a member." } }, "x-ds-definition-name": "OrganizationsResponse", "description": "Organization list.", "x-ms-summary": "Organization list." }, "OrganizationResponse": { "type": "object", "properties": { "id": { "format": "uuid", "type": "string", "example": "00000000-0000-0000-0000-000000000000", "description": "The ID of the organization." }, "name": { "type": "string", "description": "The name of the organization." }, "description": { "type": "string", "description": "A description of the organization." }, "default_account_id": { "format": "uuid", "type": "string", "example": "00000000-0000-0000-0000-000000000000", "description": "The default account ID of the organization." }, "default_permission_profile_id": { "format": "int64", "type": "integer", "description": "The default permission profile ID of the organization." }, "created_on": { "format": "date-time", "type": "string", "description": "The date the organization's account was created." }, "created_by": { "format": "uuid", "type": "string", "example": "00000000-0000-0000-0000-000000000000", "description": "The user who created the organization account." }, "last_modified_on": { "format": "date-time", "type": "string", "description": "The date the organization's account was last updated." }, "last_modified_by": { "format": "uuid", "type": "string", "example": "00000000-0000-0000-0000-000000000000", "description": "The user who last updated the organization's account." }, "accounts": { "type": "array", "items": { "$ref": "#/definitions/OrganizationAccountResponse" }, "description": "A list of organization accounts." }, "users": { "type": "array", "items": { "$ref": "#/definitions/OrganizationSimpleIdObject" }, "description": "A list of the organization accounts users." }, "reserved_domains": { "type": "array", "items": { "$ref": "#/definitions/DomainResponse" }, "description": "A list of reserved domains for the organization." }, "identity_providers": { "type": "array", "items": { "$ref": "#/definitions/IdentityProvidersResponse" }, "description": "A list of identity providers for the organization." }, "links": { "type": "array", "items": { "$ref": "#/definitions/LinkResponse" }, "description": "A list of links for the organization." } }, "x-ds-definition-name": "OrganizationResponse", "description": "Information about an individual organization.", "x-ms-summary": "Information about an individual organization." }, "OrganizationAccountResponse": { "type": "object", "properties": { "id": { "format": "uuid", "type": "string", "example": "00000000-0000-0000-0000-000000000000", "description": "The unique ID of the account." }, "name": { "type": "string", "description": "The name of the account." }, "external_account_id": { "format": "int64", "type": "integer", "description": "The external account ID." }, "site_id": { "format": "int32", "type": "integer", "description": "The site ID." } }, "x-ds-definition-name": "OrganizationAccountResponse", "description": "Information about an account.", "x-ms-summary": "Information about an account." }, "OrganizationSimpleIdObject": { "type": "object", "properties": { "id": { "format": "uuid", "type": "string", "example": "00000000-0000-0000-0000-000000000000", "description": "The ID." } }, "x-ds-definition-name": "OrganizationSimpleIdObject", "description": "An ID object.", "x-ms-summary": "An ID object." }, "DomainResponse": { "type": "object", "properties": { "id": { "format": "uuid", "type": "string", "example": "00000000-0000-0000-0000-000000000000", "description": "The ID of the reserved domain." }, "status": { "type": "string", "description": "The status of the request. One of:\n\n- `unknown`\n- `pending`\n- `active`\n- `deactivated`\n- `rejected`" }, "host_name": { "type": "string", "description": "The host name of the reserved domain." }, "txt_token": { "type": "string", "description": "A token in form of text of the reserved domain." }, "identity_provider_id": { "format": "uuid", "type": "string", "example": "00000000-0000-0000-0000-000000000000", "description": "The identity provider ID of the reserved domain." }, "settings": { "type": "array", "items": { "$ref": "#/definitions/SettingResponse" }, "description": "A list of settings for the reserved domain.\n" }, "links": { "type": "array", "items": { "$ref": "#/definitions/LinkResponse" }, "description": "A list of useful links." } }, "x-ds-definition-name": "DomainResponse", "description": "Information about a reserved domain.", "x-ms-summary": "Information about a reserved domain." }, "IdentityProvidersResponse": { "type": "object", "properties": { "identity_providers": { "type": "array", "items": { "$ref": "#/definitions/IdentityProviderResponse" }, "description": "" } }, "x-ds-definition-name": "IdentityProvidersResponse", "description": "", "x-ms-summary": "" }, "LinkResponse": { "type": "object", "properties": { "rel": { "type": "string", "description": "The kind of linked item." }, "href": { "type": "string", "description": "The URL of the linked item." } }, "x-ds-definition-name": "LinkResponse", "description": "A link to a useful URL.", "x-ms-summary": "A link to a useful URL." }, "SettingResponse": { "type": "object", "properties": { "key": { "type": "string", "description": "The key of the setting." }, "value": { "type": "object", "description": "The value of the setting." }, "type": { "type": "string", "description": "The type of the setting. One of:\n\n- `unknown`\n- `guid`\n- `text`\n- `integer`\n- `boolean`\n- `datetime`\n- `enumeration`" } }, "x-ds-definition-name": "SettingResponse", "description": "A key/value list of settings.", "x-ms-summary": "A key/value list of settings." }, "Saml2IdentityProviderResponse": { "type": "object", "properties": { "issuer": { "type": "string", "description": "The name of the certificate issuer." }, "settings": { "type": "array", "items": { "$ref": "#/definitions/SettingResponse" }, "description": "A list of settings." }, "certificates": { "type": "array", "items": { "$ref": "#/definitions/CertificateResponse" }, "description": "A list of certificates responses." }, "attribute_mappings": { "type": "array", "items": { "$ref": "#/definitions/RequiredAttributeMappingResponse" }, "description": "A list of attribute mappings." } }, "x-ds-definition-name": "Saml2IdentityProviderResponse", "description": "Information about a SAML 2.0 identity provider.", "x-ms-summary": "Information about a SAML 2.0 identity provider." }, "CertificateResponse": { "type": "object", "properties": { "id": { "format": "uuid", "type": "string", "example": "00000000-0000-0000-0000-000000000000", "description": "The unique ID of the certificate." }, "issuer": { "type": "string", "description": "The certificate issuer." }, "thumbprint": { "type": "string", "description": "The thumbprint of the certificate." }, "expiration_date": { "format": "date-time", "type": "string", "description": "The date when the certificate expires." }, "is_valid": { "type": "boolean", "readOnly": true, "description": "When **true,** the certificate is valid." }, "links": { "type": "array", "items": { "$ref": "#/definitions/LinkResponse" }, "description": "A list of useful links." } }, "x-ds-definition-name": "CertificateResponse", "description": "Information about a single certificate.", "x-ms-summary": "Information about a single certificate." }, "RequiredAttributeMappingResponse": { "type": "object", "properties": { "required_attribute_id": { "format": "int32", "type": "integer", "description": "The unique ID of the attribute." }, "required_attribute_name": { "type": "string", "description": "The name of the attribute." }, "required_attribute_friendly_name": { "type": "string", "description": "The human-readable name of the attribute." }, "substitute_attribute_name": { "type": "string", "description": "The name of the substitute attribute." } }, "x-ds-definition-name": "RequiredAttributeMappingResponse", "description": "A single attribute mapping response.", "x-ms-summary": "A single attribute mapping response." }, "PermissionsResponse": { "type": "object", "properties": { "permissions": { "type": "array", "items": { "$ref": "#/definitions/PermissionProfileResponse" }, "description": "An array of permission profile responses." } }, "x-ds-definition-name": "PermissionsResponse", "description": "A list of permission profiles for a given account.", "x-ms-summary": "A list of permission profiles for a given account." }, "PermissionProfileResponse": { "type": "object", "properties": { "id": { "format": "int64", "type": "integer", "description": "The ID of the permission profile." }, "name": { "type": "string", "description": "The name of the permission profile. \n\nExample: `DocuSign Sender`" } }, "x-ds-definition-name": "PermissionProfileResponse", "description": "This object is an individual permission profile response.", "x-ms-summary": "This object is an individual permission profile response." }, "PermissionProfileResponse2_1": { "type": "object", "properties": { "permission_profile_id": { "type": "string", "description": "The ID of the permission profile." }, "permission_profile_name": { "type": "string", "description": "The human-readable name of the permission profile." } }, "x-ds-definition-name": "PermissionProfileResponse2_1", "description": "", "x-ms-summary": "" }, "MemberGroupsResponse": { "type": "object", "properties": { "groups": { "type": "array", "items": { "$ref": "#/definitions/MemberGroupResponse" }, "description": "A list of the responses." }, "paging": { "$ref": "#/definitions/PagingResponseProperties", "description": "Information about paging though the responses." } }, "x-ds-definition-name": "MemberGroupsResponse", "description": "A response about member groups. It contains the groups and paging information.", "x-ms-summary": "A response about member groups. It contains the groups and paging information." }, "MemberGroupResponse": { "type": "object", "properties": { "id": { "format": "int64", "type": "integer", "description": "The unique ID of the group." }, "name": { "type": "string", "description": "The name of the group." }, "type": { "type": "string", "description": "The type of group. One of:\n\n- `invalid`\n- `admin_group`\n- `everyone_group`\n- `custom_group`" } }, "x-ds-definition-name": "MemberGroupResponse", "description": "And individual group responses,.", "x-ms-summary": "And individual group responses,." }, "PagingResponseProperties": { "type": "object", "properties": { "result_set_size": { "format": "int32", "type": "integer", "description": "The number of items in a result set (page)." }, "result_set_start_position": { "format": "int32", "type": "integer", "description": "The index position of the first result in this set." }, "result_set_end_position": { "format": "int32", "type": "integer", "description": "The index position of the last result in this set." }, "total_set_size": { "format": "int32", "type": "integer", "description": "The total number of results." }, "next": { "type": "string", "description": "A URL to the next set of results. " }, "previous": { "type": "string", "description": "A URL to the previous set of results. " } }, "x-ds-definition-name": "PagingResponseProperties", "description": "", "x-ms-summary": "" }, "OrganizationExportRequest": { "type": "object", "properties": { "type": { "type": "string", "description": "The type of export requested. One of:\n\n- `organization_domain_users_export`: All users of the reserved domains.\n- `organization_external_memberships_export`: Users whose email address domain is *not* linked to the organization. \n- `organization_memberships_export`: Every user in every account in the organization. Users in multiple accounts will appear more than once.\n- `organization_account_settings_export`: This value only applies to requests to export account settings." }, "accounts": { "type": "array", "items": { "$ref": "#/definitions/OrganizationExportAccount" }, "description": "" }, "domains": { "type": "array", "items": { "$ref": "#/definitions/OrganizationExportDomain" }, "description": "" } }, "x-ds-definition-name": "OrganizationExportRequest", "description": "Enables you to specify the kind of export request.", "x-ms-summary": "Enables you to specify the kind of export request." }, "OrganizationExportAccount": { "type": "object", "properties": { "account_id": { "format": "uuid", "type": "string", "example": "00000000-0000-0000-0000-000000000000", "description": "Select users that are members of the specified account. At least one of `email`, `account_id` or `organization_reserved_domain_id` must be specified." } }, "x-ds-definition-name": "OrganizationExportAccount", "description": "", "x-ms-summary": "" }, "OrganizationExportDomain": { "type": "object", "properties": { "domain": { "type": "string", "description": "" } }, "x-ds-definition-name": "OrganizationExportDomain", "description": "", "x-ms-summary": "" }, "OrganizationExportResponse": { "type": "object", "properties": { "id": { "format": "uuid", "type": "string", "example": "00000000-0000-0000-0000-000000000000", "description": "The unique ID of this request." }, "type": { "type": "string", "description": "The type of export requested. One of:\n\n- `organization_domain_users_export`: All users of the reserved domains.\n- `organization_external_memberships_export`: Users whose email address domain is *not* linked to the organization. \n- `organization_memberships_export`: Every user in every account in the organization. Users in multiple accounts will appear more than once.\n- `organization_account_settings_export`: This value only applies to requests to export account settings." }, "requestor": { "$ref": "#/definitions/OrganizationExportRequestorResponse", "description": "The user who initiated the request." }, "created": { "format": "date-time", "type": "string", "description": "The time and date the request was created. This is a date in ISO 8601 format.\n\nExample: `2019-03-26T19:02:09.8957715Z`" }, "last_modified": { "format": "date-time", "type": "string", "description": "The time and date when the request was modified. This is typically the same as `created`." }, "completed": { "format": "date-time", "type": "string", "description": "The time and date when the request completed. Null if the request is still in progress.\n" }, "expires": { "format": "date-time", "type": "string", "description": "The time and date when the request expires." }, "status": { "type": "string", "description": "The status of the request. One of:\n\n- `failed`\n- `in_process`\n- `queued`\n- `completed`\n" }, "selected_accounts": { "type": "array", "items": { "$ref": "#/definitions/OrgExportSelectedAccount" }, "description": "" }, "selected_domains": { "type": "array", "items": { "$ref": "#/definitions/OrgExportSelectedDomain" }, "description": "" }, "metadata_url": { "type": "string", "description": "A pre-configured GET request to get the status of the export. Generally this is the same URI used to access this endpoint." }, "percent_completed": { "format": "int32", "type": "integer", "description": "An integer between 0 to 100 (inclusive) that reports the progress of the request." }, "number_rows": { "format": "int64", "type": "integer", "description": "The number of rows returned in this request.\n" }, "size_bytes": { "format": "int64", "type": "integer", "description": "The size of the request in bytes." }, "results": { "type": "array", "items": { "$ref": "#/definitions/OrganizationExportTaskResponse" }, "description": "An array of results. There is one set of results for each server an account is in." }, "success": { "type": "boolean", "description": "When **true,** the request succeeded. \n" } }, "x-ds-definition-name": "OrganizationExportResponse", "description": "", "x-ms-summary": "" }, "OrganizationExportRequestorResponse": { "type": "object", "properties": { "name": { "type": "string", "description": "The name of the requestor." }, "id": { "type": "string", "description": "The unique ID of the requestor.\nIf `type` is `user`, this is the requestor's user ID." }, "type": { "type": "string", "description": "The type of the requestor. One of:\n\n- `user`\n- `client_app`" }, "email": { "type": "string", "description": "The email address of the requestor." } }, "x-ds-definition-name": "OrganizationExportRequestorResponse", "description": "", "x-ms-summary": "" }, "OrgExportSelectedAccount": { "type": "object", "properties": { "account_id": { "format": "uuid", "type": "string", "example": "00000000-0000-0000-0000-000000000000", "description": "Select users that are members of the specified account. At least one of `email`, `account_id` or `organization_reserved_domain_id` must be specified." } }, "x-ds-definition-name": "OrgExportSelectedAccount", "description": "", "x-ms-summary": "" }, "OrgExportSelectedDomain": { "type": "object", "properties": { "domain": { "type": "string", "description": "" } }, "x-ds-definition-name": "OrgExportSelectedDomain", "description": "", "x-ms-summary": "" }, "OrganizationExportTaskResponse": { "type": "object", "properties": { "id": { "format": "uuid", "type": "string", "example": "00000000-0000-0000-0000-000000000000", "description": "The unique ID of the task request." }, "site_id": { "format": "int32", "type": "integer", "description": "The ID of the site the response is for." }, "url": { "type": "string", "description": "The URL that returns the results as a CSV text stream." }, "number_rows": { "format": "int64", "type": "integer", "description": "The number of rows returned in the result." }, "size_bytes": { "format": "int64", "type": "integer", "description": "The size of the response in bytes." }, "error_details": { "$ref": "#/definitions/OETR_ErrorDetails", "description": "Error results." } }, "x-ds-definition-name": "OrganizationExportTaskResponse", "description": "", "x-ms-summary": "" }, "OETR_ErrorDetails": { "type": "object", "properties": { "error": { "type": "string", "description": "The error number." }, "error_description": { "type": "string", "description": "A longer description of the error." } }, "x-ds-definition-name": "OETR_ErrorDetails", "description": "", "x-ms-summary": "" }, "OrganizationExportsResponse": { "type": "object", "properties": { "exports": { "type": "array", "items": { "$ref": "#/definitions/OrganizationExportResponse" }, "description": "" } }, "x-ds-definition-name": "OrganizationExportsResponse", "description": "", "x-ms-summary": "" }, "OrganizationAccountsRequest": { "type": "object", "properties": { "accounts": { "type": "array", "items": { "$ref": "#/definitions/OrganizationAccountRequest" }, "description": "" } }, "x-ds-definition-name": "OrganizationAccountsRequest", "description": "", "x-ms-summary": "" }, "OrganizationAccountRequest": { "required": [ "account_id" ], "type": "object", "properties": { "account_id": { "format": "uuid", "type": "string", "example": "00000000-0000-0000-0000-000000000000", "description": "Select users that are members of the specified account. At least one of `email`, `account_id` or `organization_reserved_domain_id` must be specified." } }, "x-ds-definition-name": "OrganizationAccountRequest", "description": "", "x-ms-summary": "" }, "OrganizationAccountSettingsImportResponse": { "type": "object", "properties": { "created": { "format": "date-time", "type": "string", "description": "" }, "last_modified": { "format": "date-time", "type": "string", "description": "" }, "completed": { "format": "date-time", "type": "string", "description": "" }, "expires": { "format": "date-time", "type": "string", "description": "" }, "percent_completed": { "format": "int32", "type": "integer", "description": "" }, "number_processed_accounts": { "format": "int64", "type": "integer", "description": "" }, "number_unprocessed_accounts": { "format": "int64", "type": "integer", "description": "" }, "results": { "type": "array", "items": { "$ref": "#/definitions/OrganizationAccountSettingsImportResultResponse" }, "description": "" }, "success": { "type": "boolean", "description": "" }, "skipped_settings_by_account": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } }, "description": "" }, "id": { "type": "string", "description": "" }, "organization_id": { "type": "string", "description": "" }, "status": { "type": "string", "description": "Status." }, "type": { "type": "string", "description": "" }, "requestor": { "$ref": "#/definitions/OrganizationAccountSettingsImportRequestorResponse", "description": "" } }, "x-ds-definition-name": "OrganizationAccountSettingsImportResponse", "description": "", "x-ms-summary": "" }, "OrganizationAccountSettingsImportResultResponse": { "type": "object", "properties": { "id": { "format": "uuid", "type": "string", "example": "00000000-0000-0000-0000-000000000000", "description": "" }, "site_id": { "format": "int32", "type": "integer", "description": "" }, "url": { "type": "string", "description": "" }, "number_processed_accounts": { "format": "int64", "type": "integer", "description": "" }, "error_details": { "$ref": "#/definitions/OASIRR_ErrorDetails", "description": "Error results." }, "processing_issues_by_account": { "type": "array", "items": { "$ref": "#/definitions/OASIRR_OrganizationAccountSettingsErrorDataResponse" }, "description": "" }, "number_unprocessed_accounts": { "format": "int64", "type": "integer", "description": "" } }, "x-ds-definition-name": "OrganizationAccountSettingsImportResultResponse", "description": "", "x-ms-summary": "" }, "OrganizationAccountSettingsImportRequestorResponse": { "type": "object", "properties": { "id": { "type": "string", "description": "" }, "type": { "type": "string", "description": "" }, "name": { "type": "string", "description": "" }, "email": { "type": "string", "description": "The email address." } }, "x-ds-definition-name": "OrganizationAccountSettingsImportRequestorResponse", "description": "", "x-ms-summary": "" }, "OASIRR_ErrorDetails": { "type": "object", "properties": { "error": { "type": "string", "description": "The error number." }, "error_description": { "type": "string", "description": "A longer description of the error." } }, "x-ds-definition-name": "OASIRR_ErrorDetails", "description": "", "x-ms-summary": "" }, "OASIRR_OrganizationAccountSettingsErrorDataResponse": { "type": "object", "properties": { "account_id": { "type": "string", "description": "Select users that are members of the specified account. At least one of `email`, `account_id` or `organization_reserved_domain_id` must be specified." }, "account_name": { "type": "string", "description": "" }, "error": { "type": "string", "description": "The error number." }, "error_key": { "type": "string", "description": "" }, "setting_key": { "type": "string", "description": "" } }, "x-ds-definition-name": "OASIRR_OrganizationAccountSettingsErrorDataResponse", "description": "", "x-ms-summary": "" }, "OrganizationImportResponse": { "type": "object", "properties": { "id": { "format": "uuid", "type": "string", "example": "00000000-0000-0000-0000-000000000000", "description": "" }, "type": { "type": "string", "description": "" }, "requestor": { "$ref": "#/definitions/OrganizationImportResponseRequestor", "description": "" }, "created": { "format": "date-time", "type": "string", "description": "" }, "last_modified": { "format": "date-time", "type": "string", "description": "" }, "status": { "type": "string", "description": "Status." }, "user_count": { "format": "int32", "type": "integer", "description": "" }, "processed_user_count": { "format": "int32", "type": "integer", "description": "" }, "added_user_count": { "format": "int32", "type": "integer", "description": "" }, "updated_user_count": { "format": "int32", "type": "integer", "description": "" }, "closed_user_count": { "format": "int32", "type": "integer", "description": "" }, "no_action_required_user_count": { "format": "int32", "type": "integer", "description": "" }, "error_count": { "format": "int32", "type": "integer", "description": "" }, "warning_count": { "format": "int32", "type": "integer", "description": "" }, "invalid_column_headers": { "type": "string", "description": "" }, "imports_not_found_or_not_available_for_accounts": { "type": "string", "description": "" }, "imports_failed_for_accounts": { "type": "string", "description": "" }, "imports_timed_out_for_accounts": { "type": "string", "description": "" }, "imports_not_found_or_not_available_for_sites": { "type": "string", "description": "" }, "imports_failed_for_sites": { "type": "string", "description": "" }, "imports_timed_out_for_sites": { "type": "string", "description": "" }, "file_level_error_rollups": { "type": "array", "items": { "$ref": "#/definitions/OrganizationImportResponseErrorRollup" }, "description": "" }, "user_level_error_rollups": { "type": "array", "items": { "$ref": "#/definitions/OrganizationImportResponseErrorRollup" }, "description": "" }, "user_level_warning_rollups": { "type": "array", "items": { "$ref": "#/definitions/OrganizationImportResponseWarningRollup" }, "description": "" }, "has_csv_results": { "type": "boolean", "description": "" }, "results_uri": { "type": "string", "description": "" } }, "x-ds-definition-name": "OrganizationImportResponse", "description": "", "x-ms-summary": "" }, "OrganizationImportResponseRequestor": { "type": "object", "properties": { "name": { "type": "string", "description": "The name of the requestor." }, "id": { "type": "string", "description": "The unique ID of the requestor.\nIf `type` is `user`, this is the requestor's user ID." }, "type": { "type": "string", "description": "The type of the requestor. One of:\n\n- `user`\n- `client_app`" }, "email": { "type": "string", "description": "The email address of the requestor." } }, "x-ds-definition-name": "OrganizationImportResponseRequestor", "description": "", "x-ms-summary": "" }, "OrganizationImportResponseErrorRollup": { "type": "object", "properties": { "error_type": { "type": "string", "description": "The type of error. One of:\n\n\n- `no_action_taken_user_exists`\n- `user_added`\n- `user_updated`\n- `invalid_column_header`\n- `invalid_row_data`\n- `insufficient_row_data_found`\n- `extra_row_data_found`\n- `blank_username`\n- `invalid_characters_in_username`\n- `invalid_useremail_address`\n- `email_domain_is_reserved`\n- `new_name_with_existing_useremail_not_allowed`\n- `invalid_characters_in_jobtitle`\n- `invalid_membership_id`\n- `membership_not_in_account`\n- `maximum_users_exceeded`\n- `invalid_permissionset`\n- `user_permissionset_problems`\n- `invalid_group`\n- `user_group_problems`\n- `group_and_permissionset_problems`\n- `column_headers_missing`\n- `invalid_csv_data_or_syntax`\n- `invalid_characters_in_companyname`\n- `invalid_language_code`\n- `username_column_header_missing`\n- `useremail_column_header_missing`\n- `permissionset_column_header_missing`\n- `membership_id_column_header_usage_not_permitted`\n- `administrator_group_assignment_not_permitted`\n- `user_awaiting_activation`\n- `account_admin_access_denied`\n- `invalid_characters_in_address`\n- `permissionset_required`\n- `apiusername_column_header_missing`\n- `invalid_apiusername`\n- `useremail_username_combination_exists`\n- `permissionset_change_not_allowed`\n- `username_language_changes_ignored_warning`\n- `invalid_country_warning`\n- `invalid_account_id`\n- `invalid_autoactivate`\n- `invalid_loginpolicy`\n- `autoactivate_not_allowed`\n- `membership_closed`\n- `membership_closed_or_disabled_warning`\n- `cannot_close_last_active_admin`\n- `no_action_taken`\n- `cannot_close_own_membership`\n- `unspecified_error`\n\n" }, "count": { "format": "int32", "type": "integer", "description": "The number of errors of this type." } }, "x-ds-definition-name": "OrganizationImportResponseErrorRollup", "description": "", "x-ms-summary": "" }, "OrganizationImportResponseWarningRollup": { "type": "object", "properties": { "warning_type": { "type": "string", "description": "The type of warning." }, "count": { "format": "int32", "type": "integer", "description": "The number of warnings of this type." } }, "x-ds-definition-name": "OrganizationImportResponseWarningRollup", "description": "", "x-ms-summary": "" }, "OrganizationImportsResponse": { "type": "object", "properties": { "imports": { "type": "array", "items": { "$ref": "#/definitions/OrganizationImportResponse" }, "description": "A list of responses to user import requests." } }, "x-ds-definition-name": "OrganizationImportsResponse", "description": "", "x-ms-summary": "" }, "IdentityProviderResponse": { "type": "object", "properties": { "id": { "format": "uuid", "type": "string", "example": "00000000-0000-0000-0000-000000000000", "description": "The unique ID of the identity provider." }, "friendly_name": { "type": "string", "description": "The human-readable name of the identity provider." }, "auto_provision_users": { "type": "boolean", "description": "When **true,** users who use this identity provider are automatically provisioned. " }, "type": { "type": "string", "description": "The type of the identity provider. One of:\n\n- `none`\n- `saml_20`\n- `saml_11`\n- `saml_10`\n- `ws_federation`\n- `open_id_connect`" }, "saml_20": { "$ref": "#/definitions/Saml2IdentityProviderResponse", "description": "If `type` is `saml_20`, contains details about the SAML 2.0 response." }, "links": { "type": "array", "items": { "$ref": "#/definitions/LinkResponse" }, "description": "A list of useful URLs." } }, "x-ds-definition-name": "IdentityProviderResponse", "description": "Information about a single identity provider.", "x-ms-summary": "Information about a single identity provider." }, "OrganizationSalesforceAccountManagersResponse": { "type": "object", "properties": { "account_id": { "type": "string", "description": "Select users that are members of the specified account. At least one of `email`, `account_id` or `organization_reserved_domain_id` must be specified." }, "account_name": { "type": "string", "description": "" }, "account_type": { "type": "string", "description": "" }, "account_owner": { "$ref": "#/definitions/OSAMR_Contact", "description": "" }, "account_manager": { "$ref": "#/definitions/OSAMR_Contact", "description": "" }, "parent_account": { "$ref": "#/definitions/OrganizationSalesforceAccountManagersResponse", "description": "" } }, "x-ds-definition-name": "OrganizationSalesforceAccountManagersResponse", "description": "", "x-ms-summary": "" }, "IndividualUserDataRedactionRequest": { "type": "object", "properties": { "user_id": { "format": "uuid", "type": "string", "example": "00000000-0000-0000-0000-000000000000", "description": "The ID of the user whose data you want to delete." }, "memberships": { "type": "array", "items": { "$ref": "#/definitions/MembershipDataRedactionRequest" }, "description": "A list of accounts from which you want to delete the user's data. At least one account is required." } }, "x-ds-definition-name": "IndividualUserDataRedactionRequest", "description": "", "x-ms-summary": "" }, "IndividualMembershipDataRedactionRequest": { "type": "object", "properties": { "user_id": { "format": "uuid", "type": "string", "example": "00000000-0000-0000-0000-000000000000", "description": "The ID of the user whose data you want to delete." } }, "x-ds-definition-name": "IndividualMembershipDataRedactionRequest", "description": "", "x-ms-summary": "" }, "IndividualUserDataRedactionResponse": { "type": "object", "properties": { "user_id": { "format": "uuid", "type": "string", "readOnly": true, "example": "00000000-0000-0000-0000-000000000000", "description": "The ID of the user." }, "status": { "enum": [ "unknown", "pending", "failure", "success", "already_redacted" ], "type": "string", "readOnly": true, "description": "The overall status of the data deletion request." }, "membership_results": { "type": "array", "items": { "$ref": "#/definitions/MembershipDataRedactionResponse" }, "readOnly": true, "description": "A list of objects describing the status of the deletion request for each account." } }, "x-ds-definition-name": "IndividualUserDataRedactionResponse", "description": "", "x-ms-summary": "" }, "MembershipDataRedactionRequest": { "type": "object", "properties": { "account_id": { "format": "uuid", "type": "string", "example": "00000000-0000-0000-0000-000000000000", "description": "The ID of the account from which to delete the user's data." } }, "x-ds-definition-name": "MembershipDataRedactionRequest", "description": "", "x-ms-summary": "" }, "MembershipDataRedactionResponse": { "type": "object", "properties": { "account_id": { "format": "uuid", "type": "string", "readOnly": true, "example": "00000000-0000-0000-0000-000000000000", "description": "The ID of the account." }, "status": { "enum": [ "unknown", "pending", "failure", "success", "already_redacted" ], "type": "string", "readOnly": true, "description": "The status of the data deletion request. Valid values:\n- `success`\n- `pending`\n- `failure`\n- `already_redacted`\n" } }, "x-ds-definition-name": "MembershipDataRedactionResponse", "description": "An object describing the status of the data deletion request for a specific account.", "x-ms-summary": "An object describing the status of the data deletion request for a specific account." }, "OSAMR_Contact": { "type": "object", "properties": { "name": { "type": "string", "description": "" }, "email": { "type": "string", "description": "The email address." }, "title": { "type": "string", "description": "" } }, "x-ds-definition-name": "OSAMR_Contact", "description": "", "x-ms-summary": "" }, "OrgReportRequest": { "type": "object", "properties": { "report_type": { "type": "string", "description": "" }, "report_date_range": { "type": "string", "description": "" }, "account_ids": { "type": "array", "items": { "format": "uuid", "type": "string", "example": "00000000-0000-0000-0000-000000000000" }, "description": "" }, "custom_start_date": { "format": "date-time", "type": "string", "description": "" }, "custom_end_date": { "format": "date-time", "type": "string", "description": "" } }, "x-ds-definition-name": "OrgReportRequest", "description": "", "x-ms-summary": "" }, "OrgReportCreateResponse": { "type": "object", "properties": { "report_correlation_id": { "format": "uuid", "type": "string", "example": "00000000-0000-0000-0000-000000000000", "description": "" } }, "x-ds-definition-name": "OrgReportCreateResponse", "description": "", "x-ms-summary": "" }, "OrgReportListResponse": { "type": "object", "properties": { "reports": { "type": "array", "items": { "$ref": "#/definitions/OrgReportListResponse_OrgReport" }, "description": "" } }, "x-ds-definition-name": "OrgReportListResponse", "description": "", "x-ms-summary": "" }, "OrgReportListResponse_OrgReport": { "type": "object", "properties": { "complete": { "type": "boolean", "description": "" }, "report_correlation_id": { "format": "uuid", "type": "string", "example": "00000000-0000-0000-0000-000000000000", "description": "" }, "site_id": { "format": "int32", "type": "integer", "description": "" }, "report_id": { "format": "uuid", "type": "string", "example": "00000000-0000-0000-0000-000000000000", "description": "" }, "requestor": { "$ref": "#/definitions/OrgReportListResponse_Requestor", "description": "" }, "created_on": { "format": "date-time", "type": "string", "description": "" }, "account_export_count": { "format": "int32", "type": "integer", "description": "" }, "url": { "type": "string", "description": "" }, "report_type_id": { "type": "string", "description": "" }, "report_date_range": { "type": "string", "description": "" }, "custom_start_date": { "format": "date-time", "type": "string", "description": "" }, "custom_end_date": { "format": "date-time", "type": "string", "description": "" } }, "x-ds-definition-name": "OrgReportListResponse_OrgReport", "description": "", "x-ms-summary": "" }, "OrgReportListResponse_Requestor": { "type": "object", "properties": { "id": { "format": "uuid", "type": "string", "example": "00000000-0000-0000-0000-000000000000", "description": "" }, "name": { "type": "string", "description": "" } }, "x-ds-definition-name": "OrgReportListResponse_Requestor", "description": "", "x-ms-summary": "" }, "OrgReportConfigurationResponse": { "type": "object", "properties": { "is_account_limit_disabled": { "type": "boolean", "description": "" }, "custom_dates_enabled": { "type": "boolean", "description": "" }, "enabled_report_types": { "type": "array", "items": { "format": "int32", "type": "integer" }, "description": "" } }, "x-ds-definition-name": "OrgReportConfigurationResponse", "description": "", "x-ms-summary": "" }, "DomainsResponse": { "type": "object", "properties": { "reserved_domains": { "type": "array", "items": { "$ref": "#/definitions/DomainResponse" }, "description": "Information about reserved domains." } }, "x-ds-definition-name": "DomainsResponse", "description": "A response about reserved domains.", "x-ms-summary": "A response about reserved domains." }, "UpdateUsersRequest": { "type": "object", "properties": { "users": { "type": "array", "items": { "$ref": "#/definitions/UpdateUserRequest" }, "description": "A list of users whose information you want to change." }, "auto_activate_memberships_on_reactivation": { "type": "boolean", "description": "" } }, "x-ds-definition-name": "UpdateUsersRequest", "description": "A list of users whose information you want to change.", "x-ms-summary": "A list of users whose information you want to change." }, "UpdateUserRequest": { "required": [ "id", "site_id" ], "type": "object", "properties": { "id": { "format": "uuid", "type": "string", "example": "00000000-0000-0000-0000-000000000000", "description": "The user's unique ID." }, "site_id": { "format": "int32", "type": "integer", "description": "The site ID." }, "user_name": { "type": "string", "description": "The full name of the user." }, "first_name": { "type": "string", "description": "The user's first name." }, "last_name": { "type": "string", "description": "The user's last name." }, "email": { "type": "string", "description": "The email address." }, "default_account_id": { "format": "uuid", "type": "string", "example": "00000000-0000-0000-0000-000000000000", "description": "The account ID of the user's default account." }, "language_culture": { "type": "string", "description": "The language and culture of the user.\n\n * Chinese Simplified: `zh_CN`\n * Chinese Traditional: `zh_TW`\n * Dutch: `nl`\n * English: `en`\n * French: `fr`\n * German: `de`\n * Italian: `it`\n * Japanese: `ja`\n * Korean: `ko`\n * Portuguese: `pt`\n * Portuguese Brazil: `pt_BR`\n * Russian: `ru`\n * Spanish: `es`\n" }, "selected_languages": { "type": "string", "description": "" }, "federated_status": { "type": "string", "description": "The user's federated status. One of:\n\n- `RemoveStatus`\n- `FedAuthRequired`\n- `FedAuthBypass`\n- `Evicted`" }, "force_password_change": { "type": "boolean", "description": "When **true,** the user will be required to change the account password." }, "memberships": { "type": "array", "items": { "$ref": "#/definitions/UpdateMembershipRequest" }, "description": "A list of group membership requests." }, "device_verification_enabled": { "type": "boolean", "description": "" } }, "x-ds-definition-name": "UpdateUserRequest", "description": "Request to change a user's information.", "x-ms-summary": "Request to change a user's information." }, "UpdateMembershipRequest": { "required": [ "account_id" ], "type": "object", "properties": { "account_id": { "format": "uuid", "type": "string", "example": "00000000-0000-0000-0000-000000000000", "description": "The user's unique ID." }, "permission_profile": { "$ref": "#/definitions/PermissionProfileRequest", "description": "The user's permission profile." }, "groups": { "type": "array", "items": { "$ref": "#/definitions/GroupRequest" }, "description": "The user's requested groups." }, "company_name": { "type": "string", "description": "The user's company name." }, "job_title": { "type": "string", "description": "The user's job title." }, "send_activation": { "type": "boolean", "description": "When **true,** send an activation request after the update." }, "access_code": { "type": "string", "description": "The access code that the user needs to activate an account." }, "license_type": { "type": "string", "description": "" } }, "x-ds-definition-name": "UpdateMembershipRequest", "description": "A request to update group membership.", "x-ms-summary": "A request to update group membership." }, "PermissionProfileRequest": { "required": [ "id" ], "type": "object", "properties": { "id": { "format": "int64", "type": "integer", "description": "The ID of the permission profile." }, "name": { "type": "string", "description": "The name of the permission profile." } }, "x-ds-definition-name": "PermissionProfileRequest", "description": "A permission profile.", "x-ms-summary": "A permission profile." }, "GroupRequest": { "required": [ "id" ], "type": "object", "properties": { "id": { "format": "int64", "type": "integer", "description": "The ID of the group." }, "name": { "type": "string", "description": "The name of the group." }, "type": { "type": "string", "description": "The type of group. One of:\n\n- `invalid`\n- `admin_group`\n- `everyone_group`\n- `custom_group`" } }, "x-ds-definition-name": "GroupRequest", "description": "A group for a user to belong to.", "x-ms-summary": "A group for a user to belong to." }, "UsersUpdateResponse": { "type": "object", "properties": { "success": { "type": "boolean", "description": "When **true,** the request to change user information succeeded." }, "users": { "type": "array", "items": { "$ref": "#/definitions/UserUpdateResponse" }, "description": "A list of users whose email addresses have been updated." } }, "x-ds-definition-name": "UsersUpdateResponse", "description": "The results of changing a user's information.", "x-ms-summary": "The results of changing a user's information." }, "UserUpdateResponse": { "type": "object", "properties": { "id": { "format": "uuid", "type": "string", "example": "00000000-0000-0000-0000-000000000000", "description": "The ID of the user whose email address has been updated." }, "site_id": { "format": "int32", "type": "integer", "description": "The site ID." }, "email": { "type": "string", "description": "The email address." }, "error_details": { "$ref": "#/definitions/ErrorDetails", "description": "Error results." } }, "x-ds-definition-name": "UserUpdateResponse", "description": "Error result of attempting to change a user's email address.", "x-ms-summary": "Error result of attempting to change a user's email address." }, "ErrorDetails": { "type": "object", "properties": { "error": { "type": "string", "description": "The code for the error." }, "error_description": { "type": "string", "description": "A description of the error." } }, "x-ds-definition-name": "ErrorDetails", "description": "Errors.", "x-ms-summary": "Errors." }, "UpdateUsersEmailRequest": { "type": "object", "properties": { "users": { "type": "array", "items": { "$ref": "#/definitions/UpdateUserEmailRequest" }, "description": "A list of users whose email address to change." } }, "x-ds-definition-name": "UpdateUsersEmailRequest", "description": "A change email request.", "x-ms-summary": "A change email request." }, "UpdateUserEmailRequest": { "required": [ "id", "site_id", "email" ], "type": "object", "properties": { "id": { "format": "uuid", "type": "string", "example": "00000000-0000-0000-0000-000000000000", "description": "The ID of the users whose email address you want to change." }, "site_id": { "format": "int32", "type": "integer", "description": "The site ID." }, "email": { "type": "string", "description": "The new email address." } }, "x-ds-definition-name": "UpdateUserEmailRequest", "description": "And individual change of email.", "x-ms-summary": "And individual change of email." }, "DeleteMembershipsRequest": { "required": [ "accounts" ], "type": "object", "properties": { "accounts": { "type": "array", "items": { "$ref": "#/definitions/DeleteMembershipRequest" }, "description": "A list of accounts to close for a user." } }, "x-ds-definition-name": "DeleteMembershipsRequest", "description": "A list of accounts to close for a user.", "x-ms-summary": "A list of accounts to close for a user." }, "DeleteMembershipRequest": { "required": [ "id" ], "type": "object", "properties": { "id": { "format": "uuid", "type": "string", "example": "00000000-0000-0000-0000-000000000000", "description": "The ID of a user's account you want to close." } }, "x-ds-definition-name": "DeleteMembershipRequest", "description": "", "x-ms-summary": "" }, "DeleteMembershipsResponse": { "type": "object", "properties": { "success": { "type": "boolean", "description": "When **true,** the request to close the accounts succeeded." }, "accounts": { "type": "array", "items": { "$ref": "#/definitions/DeleteMembershipResponse" }, "description": "A list of accounts that were closed." } }, "x-ds-definition-name": "DeleteMembershipsResponse", "description": "The results of closing a user's account.", "x-ms-summary": "The results of closing a user's account." }, "DeleteMembershipResponse": { "type": "object", "properties": { "id": { "format": "uuid", "type": "string", "example": "00000000-0000-0000-0000-000000000000", "description": "The ID of an account that could not be closed." }, "error_details": { "$ref": "#/definitions/ErrorDetails", "description": "Error results." } }, "x-ds-definition-name": "DeleteMembershipResponse", "description": "Results of closing accounts.", "x-ms-summary": "Results of closing accounts." }, "OrganizationUsersResponse": { "type": "object", "properties": { "users": { "type": "array", "items": { "$ref": "#/definitions/OrganizationUserResponse" }, "description": "A list of users." }, "paging": { "$ref": "#/definitions/PagingResponseProperties", "description": "Contains information about paging through the results." } }, "x-ds-definition-name": "OrganizationUsersResponse", "description": "A response containing information about users.", "x-ms-summary": "A response containing information about users." }, "OrganizationUserResponse": { "type": "object", "properties": { "id": { "format": "uuid", "type": "string", "example": "00000000-0000-0000-0000-000000000000", "description": "The user's unique ID." }, "user_name": { "type": "string", "description": "The full name of the user." }, "first_name": { "type": "string", "description": "The user's first name." }, "last_name": { "type": "string", "description": "The user's last name." }, "user_status": { "type": "string", "description": "The user's status. One of:\n\n- `active`\n- `created`\n- `closed`\n" }, "membership_status": { "type": "string", "description": "The user's membership status. One of:\n\n- `activation_required`\n- `activation_sent`\n- `active`\n- `closed`\n- `disabled`\n" }, "email": { "type": "string", "description": "The email address." }, "created_on": { "format": "date-time", "type": "string", "description": "The date the user's account was created." }, "closed_on": { "format": "date-time", "type": "string", "description": "" }, "membership_created_on": { "format": "date-time", "type": "string", "description": "The date on which the user became a member of the organization." }, "membership_closed_on": { "format": "date-time", "type": "string", "description": "" }, "ds_groups": { "type": "array", "items": { "$ref": "#/definitions/DSGroupResponse" }, "description": "" }, "membership_id": { "format": "uuid", "type": "string", "example": "00000000-0000-0000-0000-000000000000", "description": "" }, "is_membership_managed_by_scim": { "type": "boolean", "description": "" }, "is_managed_by_scim": { "type": "boolean", "description": "" }, "license_type": { "type": "string", "description": "" }, "subscription_id": { "type": "string", "description": "" }, "plan_name": { "type": "string", "description": "" } }, "x-ds-definition-name": "OrganizationUserResponse", "description": "Information about a user.", "x-ms-summary": "Information about a user." }, "DSGroupResponse": { "type": "object", "properties": { "ds_group_id": { "format": "uuid", "type": "string", "example": "00000000-0000-0000-0000-000000000000", "description": "" }, "account_id": { "format": "uuid", "type": "string", "example": "00000000-0000-0000-0000-000000000000", "description": "Select users that are members of the specified account. At least one of `email`, `account_id` or `organization_reserved_domain_id` must be specified." }, "source_product_name": { "type": "string", "description": "" }, "group_id": { "type": "string", "description": "" }, "group_name": { "type": "string", "description": "" }, "description": { "type": "string", "description": "" }, "is_admin": { "type": "boolean", "description": "" }, "last_modified_on": { "format": "date-time", "type": "string", "description": "" }, "user_count": { "format": "int32", "type": "integer", "description": "" }, "external_account_id": { "format": "int64", "type": "integer", "description": "" }, "account_name": { "type": "string", "description": "" }, "is_managed_by_scim": { "type": "boolean", "description": "" } }, "x-ds-definition-name": "DSGroupResponse", "description": "", "x-ms-summary": "" }, "NewUserRequest": { "required": [ "accounts", "email" ], "type": "object", "properties": { "accounts": { "type": "array", "items": { "$ref": "#/definitions/NewUserRequestAccountProperties" }, "description": "A list of accounts the user will belong to." }, "user_name": { "type": "string", "description": "The full name of the user." }, "first_name": { "type": "string", "description": "The user's first name." }, "last_name": { "type": "string", "description": "The user's last name." }, "email": { "type": "string", "description": "The email address." }, "default_account_id": { "format": "uuid", "type": "string", "example": "00000000-0000-0000-0000-000000000000", "description": "The account ID of the user's default account." }, "language_culture": { "type": "string", "description": "The language and culture of the user.\n\n * Chinese Simplified: `zh_CN`\n * Chinese Traditional: `zh_TW`\n * Dutch: `nl`\n * English: `en`\n * French: `fr`\n * German: `de`\n * Italian: `it`\n * Japanese: `ja`\n * Korean: `ko`\n * Portuguese: `pt`\n * Portuguese Brazil: `pt_BR`\n * Russian: `ru`\n * Spanish: `es`\n" }, "selected_languages": { "type": "string", "description": "" }, "access_code": { "type": "string", "description": "The access code that the user needs to activate an account." }, "federated_status": { "type": "string", "description": "The user's federated status. One of:\n\n- `RemoveStatus`\n- `FedAuthRequired`\n- `FedAuthBypass`\n- `Evicted`" }, "auto_activate_memberships": { "type": "boolean", "description": "When **true,** the user's account is activated automatically." } }, "x-ds-definition-name": "NewUserRequest", "description": "Information about a new user.", "x-ms-summary": "Information about a new user." }, "NewUserRequestAccountProperties": { "required": [ "id" ], "type": "object", "properties": { "id": { "format": "uuid", "type": "string", "example": "00000000-0000-0000-0000-000000000000", "description": "The account ID." }, "permission_profile": { "$ref": "#/definitions/PermissionProfileRequest", "description": "The new user's permission profile." }, "groups": { "type": "array", "items": { "$ref": "#/definitions/GroupRequest" }, "description": "The new user's requested groups." }, "company_name": { "type": "string", "description": "The user's company name." }, "job_title": { "type": "string", "description": "The user's job title." } }, "x-ds-definition-name": "NewUserRequestAccountProperties", "description": "An individual new account user.", "x-ms-summary": "An individual new account user." }, "NewUserResponse": { "type": "object", "properties": { "id": { "format": "uuid", "type": "string", "example": "00000000-0000-0000-0000-000000000000", "description": "The ID of the added user" }, "site_id": { "format": "int32", "type": "integer", "description": "The site ID of the added user." }, "user_name": { "type": "string", "description": "The full name of the user." }, "first_name": { "type": "string", "description": "The user's first name." }, "last_name": { "type": "string", "description": "The user's last name." }, "email": { "type": "string", "description": "The primary email address of the user." }, "language_culture": { "type": "string", "description": "The language and culture of the user.\n\n * Chinese Simplified: `zh_CN`\n * Chinese Traditional: `zh_TW`\n * Dutch: `nl`\n * English: `en`\n * French: `fr`\n * German: `de`\n * Italian: `it`\n * Japanese: `ja`\n * Korean: `ko`\n * Portuguese: `pt`\n * Portuguese Brazil: `pt_BR`\n * Russian: `ru`\n * Spanish: `es`\n" }, "federated_status": { "type": "string", "description": "The user's federated status. One of:\n\n- `RemoveStatus`\n- `FedAuthRequired`\n- `FedAuthBypass`\n- `Evicted`\n" }, "accounts": { "type": "array", "items": { "$ref": "#/definitions/NewUserResponseAccountProperties" }, "description": "A list of accounts the user belongs to." } }, "x-ds-definition-name": "NewUserResponse", "description": "Information about a newly created user.", "x-ms-summary": "Information about a newly created user." }, "NewUserResponseAccountProperties": { "type": "object", "properties": { "id": { "format": "uuid", "type": "string", "example": "00000000-0000-0000-0000-000000000000", "description": "The user's unique ID." }, "site_id": { "format": "int32", "type": "integer", "description": "The site ID of the account." }, "permission_profile": { "$ref": "#/definitions/PermissionProfileResponse", "description": "A profile or list of the permissions the user has access to." }, "groups": { "type": "array", "items": { "$ref": "#/definitions/MemberGroupResponse" }, "description": "A list of groups that the user belongs to." }, "company_name": { "type": "string", "description": "The user's company name." }, "job_title": { "type": "string", "description": "The job title of the user." }, "license_type": { "type": "string", "description": "" }, "subscription_id": { "type": "string", "description": "" }, "plan_name": { "type": "string", "description": "" }, "license_status": { "type": "string", "description": "" } }, "x-ds-definition-name": "NewUserResponseAccountProperties", "description": "Information about a newly created user.", "x-ms-summary": "Information about a newly created user." }, "ForceActivateMembershipRequest": { "required": [ "site_id" ], "type": "object", "properties": { "site_id": { "format": "int32", "type": "integer", "description": "" } }, "x-ds-definition-name": "ForceActivateMembershipRequest", "description": "", "x-ms-summary": "" }, "UpdateResponse": { "type": "object", "properties": { "status": { "type": "string", "description": "The status of the request.\n" } }, "x-ds-definition-name": "UpdateResponse", "description": "A response.", "x-ms-summary": "A response." }, "UsersDrilldownResponse": { "type": "object", "properties": { "users": { "type": "array", "items": { "$ref": "#/definitions/UserDrilldownResponse" }, "description": "A list of users." } }, "x-ds-definition-name": "UsersDrilldownResponse", "description": "Information about a list of users.", "x-ms-summary": "Information about a list of users." }, "UserDrilldownResponse": { "type": "object", "properties": { "id": { "format": "uuid", "type": "string", "example": "00000000-0000-0000-0000-000000000000", "description": "The user's unique ID." }, "site_id": { "format": "int32", "type": "integer", "description": "The site ID of the organization." }, "site_name": { "type": "string", "description": "The site name of the account." }, "user_name": { "type": "string", "description": "The full name of the user." }, "first_name": { "type": "string", "description": "The user's first name." }, "last_name": { "type": "string", "description": "The user's last name." }, "user_status": { "type": "string", "description": "The user's status. One of:\n\n- `active`\n- `created`\n- `closed`\n" }, "default_account_id": { "format": "uuid", "type": "string", "example": "00000000-0000-0000-0000-000000000000", "description": "The ID of the user's default account." }, "default_account_name": { "type": "string", "description": "The name of the user's default account." }, "language_culture": { "type": "string", "description": "The language and culture of the user.\n\n * Chinese Simplified: `zh_CN`\n * Chinese Traditional: `zh_TW`\n * Dutch: `nl`\n * English: `en`\n * French: `fr`\n * German: `de`\n * Italian: `it`\n * Japanese: `ja`\n * Korean: `ko`\n * Portuguese: `pt`\n * Portuguese Brazil: `pt_BR`\n * Russian: `ru`\n * Spanish: `es`\n" }, "selected_languages": { "type": "string", "description": "" }, "federated_status": { "type": "string", "description": "The user's federated status. One of:\n\n- `RemoveStatus`\n- `FedAuthRequired`\n- `FedAuthBypass`\n- `Evicted`\n" }, "is_organization_admin": { "type": "boolean", "description": "When **true,** the user has organization administration privileges." }, "created_on": { "format": "date-time", "type": "string", "description": "The date the user's account was created." }, "last_login": { "format": "date-time", "type": "string", "description": "This property has been deprecated." }, "memberships": { "type": "array", "items": { "$ref": "#/definitions/MembershipResponse" }, "description": "A list of organizations that have groups that the user is a member of." }, "identities": { "type": "array", "items": { "$ref": "#/definitions/UserIdentityResponse" }, "description": "A list of identities associated with the user." }, "device_verification_enabled": { "type": "boolean", "description": "" }, "require_two_step_verification": { "type": "boolean", "description": "" }, "allow_two_step_verification_snooze": { "type": "boolean", "description": "" }, "allow_extend_org_admin_rights_to_self": { "type": "boolean", "description": "" }, "is_managed_by_scim": { "type": "boolean", "description": "" } }, "x-ds-definition-name": "UserDrilldownResponse", "description": "Information about a user.", "x-ms-summary": "Information about a user." }, "MembershipResponse": { "type": "object", "properties": { "id": { "format": "uuid", "type": "string", "example": "00000000-0000-0000-0000-000000000000", "description": "" }, "email": { "type": "string", "description": "The email address." }, "account_id": { "format": "uuid", "type": "string", "example": "00000000-0000-0000-0000-000000000000", "description": "The ID of the account." }, "external_account_id": { "type": "string", "description": "The external account ID." }, "account_name": { "type": "string", "description": "The name of the account." }, "is_external_account": { "type": "boolean", "description": "When **true,**\nthis is an external account." }, "status": { "type": "string", "description": "The status of the user's membership." }, "permission_profile": { "$ref": "#/definitions/PermissionProfileResponse", "description": "The user's permission profile." }, "created_on": { "format": "date-time", "type": "string", "description": "The date the user's account was created." }, "groups": { "type": "array", "items": { "$ref": "#/definitions/MemberGroupResponse" }, "description": "A list of groups the user is a member of in this account," }, "is_admin": { "type": "boolean", "description": "When **true,**\nthe user has administration \nprivileges on the account." }, "license_type": { "type": "string", "description": "" }, "subscription_id": { "type": "string", "description": "" }, "plan_name": { "type": "string", "description": "" } }, "x-ds-definition-name": "MembershipResponse", "description": "Information about group membership.", "x-ms-summary": "Information about group membership." }, "UserIdentityResponse": { "type": "object", "properties": { "id": { "format": "uuid", "type": "string", "example": "00000000-0000-0000-0000-000000000000", "description": "The ID of the result." }, "provider_id": { "format": "uuid", "type": "string", "example": "00000000-0000-0000-0000-000000000000", "description": "The ID of the identity provider." }, "user_id": { "format": "uuid", "type": "string", "example": "00000000-0000-0000-0000-000000000000", "description": "The user ID." }, "immutable_id": { "type": "string", "description": "A unique ID to identify the removed user." }, "error_details": { "$ref": "#/definitions/ErrorDetails", "description": "Error results." } }, "x-ds-definition-name": "UserIdentityResponse", "description": "Results of deleting a user identity.", "x-ms-summary": "Results of deleting a user identity." }, "DeleteUserIdentityRequest": { "required": [ "identities" ], "type": "object", "properties": { "identities": { "type": "array", "items": { "$ref": "#/definitions/UserIdentityRequest" }, "description": "A list of identities." } }, "x-ds-definition-name": "DeleteUserIdentityRequest", "description": "Request to delete a user's identities,", "x-ms-summary": "Request to delete a user's identities," }, "UserIdentityRequest": { "type": "object", "properties": { "id": { "format": "uuid", "type": "string", "example": "00000000-0000-0000-0000-000000000000", "description": "The `provider_id` that is returned from calling `getUserProfiles`." } }, "x-ds-definition-name": "UserIdentityRequest", "description": "User identity,", "x-ms-summary": "User identity," }, "DeleteResponse": { "type": "object", "properties": { "success": { "type": "boolean", "description": "When **true,** the request succeeded." }, "identities": { "type": "array", "items": { "$ref": "#/definitions/UserIdentityResponse" }, "description": "A list of identities to delete." } }, "x-ds-definition-name": "DeleteResponse", "description": "Results of deleting identities.", "x-ms-summary": "Results of deleting identities." }, "NewAccountUserRequest": { "required": [ "email" ], "type": "object", "properties": { "permission_profile": { "$ref": "#/definitions/PermissionProfileRequest", "description": "The new user's permission profile." }, "groups": { "type": "array", "items": { "$ref": "#/definitions/GroupRequest" }, "description": "The new user's requested groups." }, "user_name": { "type": "string", "description": "The full name of the user." }, "first_name": { "type": "string", "description": "The user's first name." }, "last_name": { "type": "string", "description": "The user's last name." }, "email": { "type": "string", "description": "The email address of the user." }, "default_account_id": { "format": "uuid", "type": "string", "example": "00000000-0000-0000-0000-000000000000", "description": "The account ID of the user's default account." }, "language_culture": { "type": "string", "description": "The language and culture of the user.\n\n * Chinese Simplified: `zh_CN`\n * Chinese Traditional: `zh_TW`\n * Dutch: `nl`\n * English: `en`\n * French: `fr`\n * German: `de`\n * Italian: `it`\n * Japanese: `ja`\n * Korean: `ko`\n * Portuguese: `pt`\n * Portuguese Brazil: `pt_BR`\n * Russian: `ru`\n * Spanish: `es`\n" }, "selected_languages": { "type": "string", "description": "" }, "access_code": { "type": "string", "description": "The access code that the user needs to activate an account." }, "federated_status": { "type": "string", "description": "The user's federated status. One of:\n\n- `RemoveStatus`\n- `FedAuthRequired`\n- `FedAuthBypass`\n- `Evicted`\n" }, "auto_activate_memberships": { "type": "boolean", "description": "When **true,** the user's account is activated automatically." }, "license_type": { "type": "string", "description": "" } }, "x-ds-definition-name": "NewAccountUserRequest", "description": "A new user request.", "x-ms-summary": "A new user request." }, "DSGroupListResponse": { "type": "object", "properties": { "page": { "format": "int32", "type": "integer", "description": "The page number." }, "page_size": { "format": "int32", "type": "integer", "description": "The number of items per page." }, "total_count": { "format": "int32", "type": "integer", "description": "" }, "account_id": { "format": "uuid", "type": "string", "example": "00000000-0000-0000-0000-000000000000", "description": "Select users that are members of the specified account. At least one of `email`, `account_id` or `organization_reserved_domain_id` must be specified." }, "ds_groups": { "type": "array", "items": { "$ref": "#/definitions/DSGroupResponse" }, "readOnly": true, "description": "" } }, "x-ds-definition-name": "DSGroupListResponse", "description": "", "x-ms-summary": "" }, "DSGroupAddRequest": { "required": [ "group_name" ], "type": "object", "properties": { "group_name": { "type": "string", "description": "" }, "description": { "type": "string", "description": "" } }, "x-ds-definition-name": "DSGroupAddRequest", "description": "", "x-ms-summary": "" }, "DSGroupUsersAddRequest": { "required": [ "user_ids" ], "type": "object", "properties": { "user_ids": { "type": "array", "items": { "format": "uuid", "type": "string", "example": "00000000-0000-0000-0000-000000000000" }, "description": "" } }, "x-ds-definition-name": "DSGroupUsersAddRequest", "description": "", "x-ms-summary": "" }, "AddDSGroupAndUsersResponse": { "type": "object", "properties": { "group": { "$ref": "#/definitions/DSGroupResponse", "description": "" }, "group_users": { "$ref": "#/definitions/AddDSGroupUsersResponse", "description": "" } }, "x-ds-definition-name": "AddDSGroupAndUsersResponse", "description": "", "x-ms-summary": "" }, "AddDSGroupUsersResponse": { "type": "object", "properties": { "is_success": { "type": "boolean", "description": "" }, "TotalCount": { "format": "int32", "type": "integer", "description": "" }, "users": { "type": "array", "items": { "$ref": "#/definitions/DSGroupUserResponse" }, "description": "A list of users." } }, "x-ds-definition-name": "AddDSGroupUsersResponse", "description": "", "x-ms-summary": "" }, "DSGroupUserResponse": { "type": "object", "properties": { "user_id": { "format": "uuid", "type": "string", "example": "00000000-0000-0000-0000-000000000000", "description": "" }, "account_id": { "format": "uuid", "type": "string", "example": "00000000-0000-0000-0000-000000000000", "description": "Select users that are members of the specified account. At least one of `email`, `account_id` or `organization_reserved_domain_id` must be specified." }, "user_name": { "type": "string", "description": "The full name of the user." }, "first_name": { "type": "string", "description": "The user's first name." }, "last_name": { "type": "string", "description": "The user's last name." }, "middle_name": { "type": "string", "description": "" }, "status": { "type": "string", "description": "Status." }, "error_details": { "$ref": "#/definitions/ErrorDetails", "description": "Error results." } }, "x-ds-definition-name": "DSGroupUserResponse", "description": "", "x-ms-summary": "" }, "DSGroupAndUsersResponse": { "type": "object", "properties": { "group": { "$ref": "#/definitions/DSGroupResponse", "description": "" }, "group_users": { "$ref": "#/definitions/DSGroupUsersResponse", "description": "" } }, "x-ds-definition-name": "DSGroupAndUsersResponse", "description": "", "x-ms-summary": "" }, "DSGroupUsersResponse": { "type": "object", "properties": { "page": { "format": "int32", "type": "integer", "description": "The page number." }, "page_size": { "format": "int32", "type": "integer", "description": "The number of items per page." }, "total_count": { "format": "int32", "type": "integer", "description": "" }, "users": { "type": "array", "items": { "$ref": "#/definitions/DSGroupUserResponse" }, "description": "A list of users." } }, "x-ds-definition-name": "DSGroupUsersResponse", "description": "", "x-ms-summary": "" }, "DSGroupUsersRemoveRequest": { "type": "object", "properties": { "user_ids": { "type": "array", "items": { "format": "uuid", "type": "string", "example": "00000000-0000-0000-0000-000000000000" }, "description": "An array of IDs corresponding to users to remove from the group." }, "user_emails": { "type": "array", "items": { "type": "string" }, "description": "An array of emails associated with users to remove from the group. **Note:** If `user_ids` is also specified, this parameter will be ignored." } }, "x-ds-definition-name": "DSGroupUsersRemoveRequest", "description": "Information about users to remove from the group.", "x-ms-summary": "Information about users to remove from the group." }, "RemoveDSGroupUsersResponse": { "type": "object", "properties": { "is_success": { "type": "boolean", "description": "" }, "failed_users": { "type": "array", "items": { "$ref": "#/definitions/DSGroupUserResponse" }, "description": "" } }, "x-ds-definition-name": "RemoveDSGroupUsersResponse", "description": "", "x-ms-summary": "" }, "ProductPermissionProfilesResponse": { "type": "object", "properties": { "product_permission_profiles": { "type": "array", "items": { "$ref": "#/definitions/ProductPermissionProfileResponse" }, "readOnly": true, "description": "A list of one or more products and their respective permissions." } }, "x-ds-definition-name": "ProductPermissionProfilesResponse", "description": "", "x-ms-summary": "" }, "ProductPermissionProfileResponse": { "type": "object", "properties": { "product_id": { "format": "uuid", "type": "string", "example": "00000000-0000-0000-0000-000000000000", "description": "The ID of the product." }, "product_name": { "type": "string", "description": "The human-readable name of the product." }, "permission_profiles": { "type": "array", "items": { "$ref": "#/definitions/PermissionProfileResponse2_1" }, "description": "" }, "error_message": { "type": "string", "description": "" } }, "x-ds-definition-name": "ProductPermissionProfileResponse", "description": "", "x-ms-summary": "" }, "ProductPermissionProfilesRequest": { "required": [ "product_permission_profiles" ], "type": "object", "properties": { "product_permission_profiles": { "type": "array", "items": { "$ref": "#/definitions/ProductPermissionProfileRequest" }, "description": "A list of one or more products and their respective permissions." } }, "x-ds-definition-name": "ProductPermissionProfilesRequest", "description": "", "x-ms-summary": "" }, "ProductPermissionProfileRequest": { "required": [ "product_id", "permission_profile_id" ], "type": "object", "properties": { "product_id": { "format": "uuid", "type": "string", "example": "00000000-0000-0000-0000-000000000000", "description": "The ID of the product. This property is required." }, "permission_profile_id": { "type": "string", "description": "The ID of the permission profile for the given product. This property is required." } }, "x-ds-definition-name": "ProductPermissionProfileRequest", "description": "Identifies a product and an associated permission profile.", "x-ms-summary": "Identifies a product and an associated permission profile." }, "UserProductPermissionProfilesResponse": { "type": "object", "properties": { "user_id": { "format": "uuid", "type": "string", "example": "00000000-0000-0000-0000-000000000000", "description": "The ID of the user." }, "account_id": { "format": "uuid", "type": "string", "example": "00000000-0000-0000-0000-000000000000", "description": "The ID of the account." }, "product_permission_profiles": { "type": "array", "items": { "$ref": "#/definitions/ProductPermissionProfileResponse" }, "description": "A list of one or more products and their respective permissions." } }, "x-ds-definition-name": "UserProductPermissionProfilesResponse", "description": "", "x-ms-summary": "" }, "NewMultiProductUserAddRequest": { "required": [ "product_permission_profiles", "email" ], "type": "object", "properties": { "product_permission_profiles": { "type": "array", "items": { "$ref": "#/definitions/ProductPermissionProfileRequest" }, "description": "A list of one or more products and their respective permissions." }, "ds_groups": { "type": "array", "items": { "$ref": "#/definitions/DSGroupRequest" }, "description": "" }, "user_name": { "type": "string", "description": "The full name of the user." }, "first_name": { "type": "string", "description": "The user's first name." }, "last_name": { "type": "string", "description": "The user's last name." }, "email": { "type": "string", "description": "The email address." }, "default_account_id": { "format": "uuid", "type": "string", "example": "00000000-0000-0000-0000-000000000000", "description": "" }, "language_culture": { "type": "string", "description": "The language and culture of the user.\n\n * Chinese Simplified: `zh_CN`\n * Chinese Traditional: `zh_TW`\n * Dutch: `nl`\n * English: `en`\n * French: `fr`\n * German: `de`\n * Italian: `it`\n * Japanese: `ja`\n * Korean: `ko`\n * Portuguese: `pt`\n * Portuguese Brazil: `pt_BR`\n * Russian: `ru`\n * Spanish: `es`\n" }, "access_code": { "type": "string", "description": "The access code that the user needs to activate an account." }, "federated_status": { "type": "string", "description": "The user's federated status. One of:\n\n- `RemoveStatus`\n- `FedAuthRequired`\n- `FedAuthBypass`\n- `Evicted`" }, "auto_activate_memberships": { "type": "boolean", "description": "When **true,** the user's account is activated automatically." }, "license_type": { "type": "string", "description": "" } }, "x-ds-definition-name": "NewMultiProductUserAddRequest", "description": "", "x-ms-summary": "" }, "DSGroupRequest": { "required": [ "ds_group_id" ], "type": "object", "properties": { "ds_group_id": { "format": "uuid", "type": "string", "example": "00000000-0000-0000-0000-000000000000", "description": "" } }, "x-ds-definition-name": "DSGroupRequest", "description": "", "x-ms-summary": "" }, "AddUserResponse": { "type": "object", "properties": { "id": { "format": "uuid", "type": "string", "example": "00000000-0000-0000-0000-000000000000", "description": "" }, "site_id": { "format": "int32", "type": "integer", "description": "" }, "user_name": { "type": "string", "description": "The full name of the user." }, "first_name": { "type": "string", "description": "The user's first name." }, "last_name": { "type": "string", "description": "The user's last name." }, "email": { "type": "string", "description": "The email address." }, "language_culture": { "type": "string", "description": "The language and culture of the user.\n\n * Chinese Simplified: `zh_CN`\n * Chinese Traditional: `zh_TW`\n * Dutch: `nl`\n * English: `en`\n * French: `fr`\n * German: `de`\n * Italian: `it`\n * Japanese: `ja`\n * Korean: `ko`\n * Portuguese: `pt`\n * Portuguese Brazil: `pt_BR`\n * Russian: `ru`\n * Spanish: `es`\n" }, "federated_status": { "type": "string", "description": "The user's federated status. One of:\n\n- `RemoveStatus`\n- `FedAuthRequired`\n- `FedAuthBypass`\n- `Evicted`" }, "accounts": { "type": "array", "items": { "$ref": "#/definitions/AddUserResponseAccountProperties" }, "readOnly": true, "description": "" } }, "x-ds-definition-name": "AddUserResponse", "description": "", "x-ms-summary": "" }, "AddUserResponseAccountProperties": { "type": "object", "properties": { "id": { "format": "uuid", "type": "string", "example": "00000000-0000-0000-0000-000000000000", "description": "" }, "site_id": { "format": "int32", "type": "integer", "description": "" }, "product_permission_profiles": { "type": "array", "items": { "$ref": "#/definitions/ProductPermissionProfileResponse" }, "readOnly": true, "description": "A list of one or more products and their respective permissions." }, "ds_groups": { "type": "array", "items": { "$ref": "#/definitions/DSGroupResponse" }, "readOnly": true, "description": "" }, "company_name": { "type": "string", "description": "The user's company name." }, "job_title": { "type": "string", "description": "The user's job title." }, "license_type": { "type": "string", "description": "" }, "subscription_id": { "type": "string", "description": "" }, "plan_name": { "type": "string", "description": "" }, "license_status": { "type": "string", "description": "" } }, "x-ds-definition-name": "AddUserResponseAccountProperties", "description": "", "x-ms-summary": "" }, "UserProductProfileDeleteRequest": { "required": [ "product_ids" ], "type": "object", "properties": { "user_email": { "type": "string", "description": "The user's email address." }, "user_id": { "format": "uuid", "type": "string", "example": "00000000-0000-0000-0000-000000000000", "description": "The user's unique ID." }, "product_ids": { "type": "array", "items": { "format": "uuid", "type": "string", "example": "00000000-0000-0000-0000-000000000000" }, "description": "A list of IDs corresponding to the products for which the user's access will be revoked.\n\nFor example:\n\n`[\"230546a7-xxxx-xxxx-xxxx-af205d5494ad\", \"984800b7-xxxx-xxxx-xxxx-kt374a5922lk\"]`" } }, "x-ds-definition-name": "UserProductProfileDeleteRequest", "description": "", "x-ms-summary": "" }, "RemoveUserProductsResponse": { "required": [ "is_success", "user_product_results" ], "type": "object", "properties": { "is_success": { "type": "boolean", "description": "When **true,** indicates that the user's access to the specified products was successfully revoked." }, "user_email": { "type": "string", "description": "The user's email address." }, "user_id": { "format": "uuid", "type": "string", "example": "00000000-0000-0000-0000-000000000000", "description": "The user's ID." }, "user_product_results": { "type": "object", "additionalProperties": { "type": "string" }, "description": "The results of the request to revoke product access.\n\nEach key in the object is the ID of a product specified in the request. Each corresponding value indicates whether the user's access for that product was successfully revoked. If successful, the value is `deleted`. Otherwise, the value describes the error that occurred.\n\nFor example:\n```\n{\n \"230546a7-xxxx-xxxx-xxxx-af205d5494ad\"\": \"deleted\",\n \"984800b7-xxxx-xxxx-xxxx-kt374a5922lk\": \"Invalid product id\"\n}\n```" } }, "x-ds-definition-name": "RemoveUserProductsResponse", "description": "", "x-ms-summary": "" }, "UserProductPermissionProfilesRequest": { "required": [ "email", "product_permission_profiles" ], "type": "object", "properties": { "email": { "type": "string", "description": "The email address associated with the user whose permissions you want to update. This property is required." }, "product_permission_profiles": { "type": "array", "items": { "$ref": "#/definitions/ProductPermissionProfileRequest" }, "description": "A list of one or more products and their associated permissions." } }, "x-ds-definition-name": "UserProductPermissionProfilesRequest", "description": "", "x-ms-summary": "" }, "OrganizationConnectConfigsResponse": { "type": "object", "properties": { "configurations": { "type": "array", "items": { "$ref": "#/definitions/OrganizationConnectConfigResponse" }, "description": "" }, "totalSetSize": { "format": "int32", "type": "integer", "description": "" }, "errorDetail": { "$ref": "#/definitions/ErrorDetail", "description": "" } }, "x-ds-definition-name": "OrganizationConnectConfigsResponse", "description": "", "x-ms-summary": "" }, "ErrorDetail": { "type": "object", "properties": { "errorMessage": { "type": "string", "description": "" }, "referenceId": { "type": "string", "description": "" } }, "x-ds-definition-name": "ErrorDetail", "description": "", "x-ms-summary": "" }, "OrganizationConnectConfigResponse": { "type": "object", "properties": { "connectId": { "type": "string", "description": "" }, "configurationType": { "type": "string", "description": "" }, "disabledBy": { "type": "string", "description": "" }, "allowSalesforcePublish": { "type": "string", "description": "" }, "name": { "type": "string", "description": "" }, "accountId": { "type": "string", "description": "The account ID GUID." }, "accountName": { "type": "string", "description": "The account name of the asset group account." }, "allowEnvelopePublish": { "type": "string", "description": "" }, "siteId": { "format": "int32", "type": "integer", "description": "The site ID of the account.\n" }, "pausePublish": { "type": "string", "description": "" }, "requiresAcknowledgement": { "type": "string", "description": "" } }, "x-ds-definition-name": "OrganizationConnectConfigResponse", "description": "", "x-ms-summary": "" }, "OrganizationConnectConfigurationRequest": { "type": "object", "properties": { "connectId": { "format": "uuid", "type": "string", "example": "00000000-0000-0000-0000-000000000000", "description": "" }, "configurationType": { "type": "string", "description": "" }, "allowEnvelopePublish": { "type": "string", "description": "" }, "urlToPublishTo": { "type": "string", "description": "" }, "deliveryMode": { "type": "string", "description": "" }, "events": { "type": "array", "items": { "type": "string" }, "description": "" }, "associatedFilterSelection": { "type": "string", "description": "" }, "groupIds": { "type": "array", "items": { "type": "string" }, "description": "" }, "accountIds": { "type": "array", "items": { "type": "string" }, "description": "" }, "userIds": { "type": "array", "items": { "type": "string" }, "description": "" }, "name": { "type": "string", "description": "" }, "signMessageWithX509Certificate": { "type": "string", "description": "" }, "includeOAuth": { "type": "string", "description": "" }, "includeHMAC": { "type": "string", "description": "" }, "pausePublish": { "type": "string", "description": "" }, "eventData": { "$ref": "#/definitions/ConnectEventData", "description": "" } }, "x-ds-definition-name": "OrganizationConnectConfigurationRequest", "description": "", "x-ms-summary": "" }, "ConnectEventData": { "type": "object", "properties": { "version": { "type": "string", "description": "" }, "includeData": { "type": "array", "items": { "type": "string" }, "description": "" } }, "x-ds-definition-name": "ConnectEventData", "description": "", "x-ms-summary": "" }, "OrganizationConnectConfigurationDetailsResponse": { "type": "object", "properties": { "connectId": { "format": "uuid", "type": "string", "example": "00000000-0000-0000-0000-000000000000", "description": "" }, "configurationType": { "type": "string", "description": "" }, "allowEnvelopePublish": { "type": "string", "description": "" }, "urlToPublishTo": { "type": "string", "description": "" }, "deliveryMode": { "type": "string", "description": "" }, "events": { "type": "array", "items": { "type": "string" }, "description": "" }, "associatedFilterSelection": { "type": "string", "description": "" }, "accountIds": { "type": "array", "items": { "type": "string" }, "description": "" }, "userIds": { "type": "array", "items": { "type": "string" }, "description": "" }, "groupIds": { "type": "array", "items": { "type": "string" }, "description": "" }, "name": { "type": "string", "description": "" }, "signMessageWithX509Certificate": { "type": "string", "description": "" }, "includeOAuth": { "type": "string", "description": "" }, "includeHMAC": { "type": "string", "description": "" }, "pausePublish": { "type": "string", "description": "" }, "eventData": { "$ref": "#/definitions/ConnectEventData", "description": "" } }, "x-ds-definition-name": "OrganizationConnectConfigurationDetailsResponse", "description": "", "x-ms-summary": "" }, "OrganizationConnectHmacSecretsResponse": { "type": "object", "properties": { "secrets": { "type": "array", "items": { "type": "string" }, "description": "" } }, "x-ds-definition-name": "OrganizationConnectHmacSecretsResponse", "description": "", "x-ms-summary": "" }, "OrganizationConnectOAuthConfiguration": { "type": "object", "properties": { "authorizationServerUrl": { "type": "string", "format": "uri", "description": "" }, "clientId": { "type": "string", "description": "" }, "clientSecret": { "type": "string", "description": "" }, "scope": { "type": "string", "description": "" }, "customParameter": { "type": "object", "additionalProperties": { "type": "string" }, "description": "" } }, "x-ds-definition-name": "OrganizationConnectOAuthConfiguration", "description": "", "x-ms-summary": "" }, "IdentityProviders": { "x-ds-category": "IdentityProviders", "x-ms-summary": "Methods to get a list of identity providers.", "description": "Methods to get a list of identity providers." }, "ReservedDomains": { "x-ds-category": "ReservedDomains", "x-ms-summary": "Methods to get a list of reserved domains.", "description": "Methods to get a list of reserved domains." }, "Users": { "x-ds-category": "UserManagement", "x-ms-summary": "Methods to manage users in an account.", "description": "Methods to manage users in an account." }, "eSignUserManagement": { "x-ds-category": "UserManagement", "x-ms-summary": "Methods to manage eSignature users in an account.", "description": "Methods to manage eSignature users in an account." }, "MultiProductUserManagement": { "type": "object", "properties": { "id": { "format": "uuid", "type": "string", "example": "00000000-0000-0000-0000-000000000000", "description": "" }, "site_id": { "format": "int32", "type": "integer", "description": "" }, "user_name": { "type": "string", "description": "The full name of the user." }, "first_name": { "type": "string", "description": "The user's first name." }, "last_name": { "type": "string", "description": "The user's last name." }, "email": { "type": "string", "description": "The email address." }, "language_culture": { "type": "string", "description": "The language and culture of the user.\n\n * Chinese Simplified: `zh_CN`\n * Chinese Traditional: `zh_TW`\n * Dutch: `nl`\n * English: `en`\n * French: `fr`\n * German: `de`\n * Italian: `it`\n * Japanese: `ja`\n * Korean: `ko`\n * Portuguese: `pt`\n * Portuguese Brazil: `pt_BR`\n * Russian: `ru`\n * Spanish: `es`\n" }, "federated_status": { "type": "string", "description": "The user's federated status. One of:\n\n- `RemoveStatus`\n- `FedAuthRequired`\n- `FedAuthBypass`\n- `Evicted`" }, "accounts": { "type": "array", "items": { "$ref": "#/definitions/AddUserResponseAccountProperties" }, "readOnly": true, "description": "" } }, "x-ds-definition-name": "AddUserResponse", "description": "Methods to manage multi-product users in an account.", "x-ds-category": "UserManagement", "x-ds-order": "100", "x-ms-summary": "Methods to manage multi-product users in an account." }, "UserExport": { "x-ds-category": "BulkOperations", "x-ms-summary": "Methods for exporting a user list.", "description": "Methods for exporting a user list." }, "AccountSettingsExport": { "x-ds-category": "BulkOperations", "x-ms-summary": "Methods and objects to get account information.", "description": "Methods and objects to get account information." }, "UserImport": { "x-ds-category": "BulkOperations", "x-ms-summary": "Methods to import users.\n", "description": "Methods to import users.\n" }, "Organization": { "x-ds-category": "Organization", "x-ms-summary": "Methods for working with organizations.", "description": "Methods for working with organizations." }, "AccountSettingsImport": { "x-ds-category": "BulkOperations", "x-ms-summary": "Methods and objects to update account settings.", "description": "Methods and objects to update account settings." }, "SingleAccountUserImport": { "type": "object", "properties": { "id": { "format": "uuid", "type": "string", "example": "00000000-0000-0000-0000-000000000000", "description": "" }, "type": { "type": "string", "description": "" }, "requestor": { "$ref": "#/definitions/OrganizationImportResponseRequestor", "description": "" }, "created": { "format": "date-time", "type": "string", "description": "" }, "last_modified": { "format": "date-time", "type": "string", "description": "" }, "status": { "type": "string", "description": "Status." }, "user_count": { "format": "int32", "type": "integer", "description": "" }, "processed_user_count": { "format": "int32", "type": "integer", "description": "" }, "added_user_count": { "format": "int32", "type": "integer", "description": "" }, "updated_user_count": { "format": "int32", "type": "integer", "description": "" }, "closed_user_count": { "format": "int32", "type": "integer", "description": "" }, "no_action_required_user_count": { "format": "int32", "type": "integer", "description": "" }, "error_count": { "format": "int32", "type": "integer", "description": "" }, "warning_count": { "format": "int32", "type": "integer", "description": "" }, "invalid_column_headers": { "type": "string", "description": "" }, "imports_not_found_or_not_available_for_accounts": { "type": "string", "description": "" }, "imports_failed_for_accounts": { "type": "string", "description": "" }, "imports_timed_out_for_accounts": { "type": "string", "description": "" }, "imports_not_found_or_not_available_for_sites": { "type": "string", "description": "" }, "imports_failed_for_sites": { "type": "string", "description": "" }, "imports_timed_out_for_sites": { "type": "string", "description": "" }, "file_level_error_rollups": { "type": "array", "items": { "$ref": "#/definitions/OrganizationImportResponseErrorRollup" }, "description": "" }, "user_level_error_rollups": { "type": "array", "items": { "$ref": "#/definitions/OrganizationImportResponseErrorRollup" }, "description": "" }, "user_level_warning_rollups": { "type": "array", "items": { "$ref": "#/definitions/OrganizationImportResponseWarningRollup" }, "description": "" }, "has_csv_results": { "type": "boolean", "description": "" }, "results_uri": { "type": "string", "description": "" } }, "x-ds-definition-name": "OrganizationImportResponse", "description": "Methods to import users.", "x-ds-category": "BulkOperations", "x-ds-order": "100", "x-ms-summary": "Methods to import users." }, "DataDeletion": { "type": "object", "properties": { "user_id": { "format": "uuid", "type": "string", "readOnly": true, "example": "00000000-0000-0000-0000-000000000000", "description": "" }, "status": { "enum": [ "unknown", "pending", "failure", "success", "already_redacted" ], "type": "string", "readOnly": true, "description": "Status." }, "membership_results": { "type": "array", "items": { "$ref": "#/definitions/MembershipDataRedactionResponse" }, "readOnly": true, "description": "" } }, "x-ds-definition-name": "IndividualUserDataRedactionResponse", "description": "Methods to delete data for closed users.", "x-ds-category": "UserManagement", "x-ds-order": "100", "x-ms-summary": "Methods to delete data for closed users." }, "AccountCloning": { "type": "object", "properties": { "assetGroupAccounts": { "description": "The list of asset group accounts.", "type": "array", "items": { "$ref": "#/definitions/AssetGroupAccountResponse" }, "readOnly": true } }, "x-ds-definition-name": "AssetGroupAccountsResponse", "description": "Methods to clone accounts.", "x-ds-category": "AccountProvisioning", "x-ds-order": "100", "x-ms-summary": "Methods to clone accounts." }, "AccountCreation": { "x-ds-category": "AccountProvisioning", "x-ms-summary": "", "description": "" }, "Connect": { "type": "object", "properties": { "configurations": { "type": "array", "items": { "$ref": "#/definitions/OrganizationConnectConfigResponse" }, "description": "" }, "totalSetSize": { "format": "int32", "type": "integer", "description": "" }, "errorDetail": { "$ref": "#/definitions/ErrorDetail", "description": "" } }, "x-ds-definition-name": "OrganizationConnectConfigsResponse", "description": "", "x-ds-category": "Organization", "x-ds-order": "100", "x-ms-summary": "" } }, "securityDefinitions": { "accessCode": { "type": "oauth2", "description": "OAuth2 Access code Grant", "flow": "accessCode", "authorizationUrl": "https://account.docusign.com/oauth/auth", "tokenUrl": "https://account.docusign.com/oauth/auth", "scopes": { "organization_read": "", "user_data_redact": "", "permission_read": "", "group_read": "", "user_read": "", "account_read": "", "account_write": "", "user_write": "", "identity_provider_read": "", "domain_read": "", "asset_group_account_read": "", "asset_group_account_clone_write": "", "asset_group_account_clone_read": "", "organization_sub_account_read": "", "organization_sub_account_write": "", "connect_org_config_read_api": "", "connect_org_config_write_api": "", "connect_org_hmac_read_api": "", "connect_org_hmac_write_api": "", "connect_org_oauth_write_api": "", "connect_org_oauth_read_api": "" } } }, "tags": [ { "name": "IdentityProviders", "description": "Methods to get a list of identity providers." }, { "name": "ReservedDomains", "description": "Methods to get a list of reserved domains." }, { "name": "Users", "description": "Methods to manage users in an account." }, { "name": "eSignUserManagement", "description": "Methods to manage eSignature users in an account." }, { "name": "MultiProductUserManagement", "description": "Methods to manage multi-product users in an account." }, { "name": "UserExport", "description": "Methods for exporting a user list." }, { "name": "AccountSettingsExport", "description": "Methods and objects to get account information." }, { "name": "UserImport", "description": "Methods to import users.\n\nTo ensure your CSV is properly formatted, use the\n[Sample Bulk Add CSV file](https://admin.docusign.com/static-resources/organization-user-import.csv)\n as a template.\n\nYou can add up to 2,000 users to an account and include up to 50 accounts per import. The maximum number of users per import is 8,000." }, { "name": "Organization", "description": "Methods for working with organizations." }, { "name": "AccountSettingsImport", "description": "Methods and objects to update account settings." }, { "name": "SingleAccountUserImport", "description": "Methods to import users." }, { "name": "DataDeletion", "description": "Methods to delete user data. After a user is closed, an account or organization administrator can use these methods to delete the user's account data.\n\n### Next steps\n* Learn [how to delete user data from an account as an account administrator](/docs/admin-api/how-to/account-admin-delete-user-data/).\n* Learn [how to delete user data from multiple accounts as an organization administrator](/docs/admin-api/how-to/org-admin-delete-user-data/)." }, { "name": "AccountCloning", "description": "Methods to clone accounts." }, { "name": "AccountCreation", "description": "Methods to create accounts." }, { "name": "Connect", "description": "" } ], "x-ds-categories": [ { "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": "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": "Organization", "summary": "Methods for working with organizations.", "description": "Methods for working with organizations." }, { "name": "AccountProvisioning", "summary": "Methods to provision accounts in your organization.", "description": "Methods to provision accounts in your organization." } ] }