From 1c5ee566b9801ecacc69a177c7f26cab800c3eca Mon Sep 17 00:00:00 2001 From: Asif Sajjad Date: Fri, 18 Oct 2024 14:31:33 +0530 Subject: [PATCH] TIR - Updated assets/admin-collection.json --- assets/admin-collection.json | 8498 +++++++++++++++++++++++++--------- 1 file changed, 6225 insertions(+), 2273 deletions(-) diff --git a/assets/admin-collection.json b/assets/admin-collection.json index a28697e..875b133 100644 --- a/assets/admin-collection.json +++ b/assets/admin-collection.json @@ -1,3552 +1,7504 @@ { - "variables": [], - "info": { - "name": "DocuSign Admin API", - "_postman_id": "ec993b08-d3dc-4024-bc06-ec967fb9d12e", - "description": "An API for an organization administrator to manage organizations, accounts and users", - "schema": "https://schema.getpostman.com/json/collection/v2.0.0/collection.json" - }, "item": [ { - "_postman_id": "358d81dc-6161-4220-b0fe-68608dfad6e5", - "name": "Organization", - "description": "Folder for Organization", + "name": "IdentityProviders", + "description": "Methods to get a list of identity providers.", "item": [ { - "_postman_id": "9191256f-06c8-4bd7-8d1a-ff87a6b28f71", - "name": "Returns the list of organizations of which the authenticated user is a member.", + "id": "0c01ee6a-2408-4ad2-8a72-04e7f7fc2f76", + "name": "Returns the list of identity providers for the organization.", "request": { - "url": "https://{{hostenv}}/Management/v2/organizations?mode={{mode}}", - "method": "GET", - "header": [ - { - "key": "Accept", - "value": "application/json", - "description": "" - }, - { - "key": "Content-Type", - "value": "application/json", - "description": "" - }, - { - "key": "Authorization", - "value": "Bearer {{accessToken}}", - "description": "" - } - ], - "body": { - "mode": "raw", - "raw": "{}" + "name": "Returns the list of identity providers for an organization.", + "description": { + "content": "Required scopes: identity_provider_read", + "type": "text/markdown" }, - "description": "Required scopes: organization_read" - }, - "response": [] - } - ] - }, - { - "_postman_id": "358701b3-583a-47ff-b3ff-f71631356a26", - "name": "UserManagement", - "description": "Folder for UserManagement", - "item": [ - { - "_postman_id": "efbbadb0-eb65-40e3-a4be-2d6d262b0ec7", - "name": "Redacts membership data for users with memberships in an account.", - "request": { "url": { - "raw": "https://{{hostenv}}/Management/v2/data_redaction/accounts/{{accountId}}/user", - "protocol": "https", - "auth": {}, - "host": [ - "{{hostenv}}" - ], "path": [ - "Management", "v2", - "data_redaction", - "accounts", - "{{accountId}}", - "user" + "organizations", + ":organizationId", + "identity_providers" + ], + "host": [ + "{{baseUrl}}" ], + "query": [], "variable": [ { - "value": "{{accountId}}", - "id": "accountId" + "type": "any", + "value": "", + "key": "organizationId", + "disabled": false, + "description": { + "content": "(Required) The organization ID Guid", + "type": "text/plain" + } } ] }, - "method": "POST", "header": [ { "key": "Accept", - "value": "application/json", - "description": "" - }, - { - "key": "Content-Type", - "value": "application/json", - "description": "" - }, - { - "key": "Authorization", - "value": "Bearer {{accessToken}}", - "description": "" + "value": "application/json" } ], - "body": { - "mode": "raw", - "raw": "{}" - }, - "description": "Required scopes: user_data_redact" + "method": "GET", + "body": {}, + "auth": null }, - "response": [] - }, + "response": [ + { + "id": "e4c5ceef-13f2-4069-9779-ced095c58ee3", + "name": "OK", + "originalRequest": { + "url": { + "path": [ + "v2", + "organizations", + ":organizationId", + "identity_providers" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "GET", + "body": {} + }, + "status": "OK", + "code": 200, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"identity_providers\": [\n {\n \"id\": \"\",\n \"friendly_name\": \"\",\n \"auto_provision_users\": \"\",\n \"type\": \"\",\n \"saml_20\": {\n \"issuer\": \"\",\n \"settings\": [\n {\n \"key\": \"\",\n \"value\": {},\n \"type\": \"\"\n },\n {\n \"key\": \"\",\n \"value\": {},\n \"type\": \"\"\n }\n ],\n \"certificates\": [\n {\n \"id\": \"\",\n \"issuer\": \"\",\n \"thumbprint\": \"\",\n \"expiration_date\": \"\",\n \"is_valid\": \"\",\n \"links\": [\n {\n \"rel\": \"\",\n \"href\": \"\"\n },\n {\n \"rel\": \"\",\n \"href\": \"\"\n }\n ]\n },\n {\n \"id\": \"\",\n \"issuer\": \"\",\n \"thumbprint\": \"\",\n \"expiration_date\": \"\",\n \"is_valid\": \"\",\n \"links\": [\n {\n \"rel\": \"\",\n \"href\": \"\"\n },\n {\n \"rel\": \"\",\n \"href\": \"\"\n }\n ]\n }\n ],\n \"attribute_mappings\": [\n {\n \"required_attribute_id\": \"\",\n \"required_attribute_name\": \"\",\n \"required_attribute_friendly_name\": \"\",\n \"substitute_attribute_name\": \"\"\n },\n {\n \"required_attribute_id\": \"\",\n \"required_attribute_name\": \"\",\n \"required_attribute_friendly_name\": \"\",\n \"substitute_attribute_name\": \"\"\n }\n ]\n },\n \"links\": [\n {\n \"rel\": \"\",\n \"href\": \"\"\n },\n {\n \"rel\": \"\",\n \"href\": \"\"\n }\n ]\n },\n {\n \"id\": \"\",\n \"friendly_name\": \"\",\n \"auto_provision_users\": \"\",\n \"type\": \"\",\n \"saml_20\": {\n \"issuer\": \"\",\n \"settings\": [\n {\n \"key\": \"\",\n \"value\": {},\n \"type\": \"\"\n },\n {\n \"key\": \"\",\n \"value\": {},\n \"type\": \"\"\n }\n ],\n \"certificates\": [\n {\n \"id\": \"\",\n \"issuer\": \"\",\n \"thumbprint\": \"\",\n \"expiration_date\": \"\",\n \"is_valid\": \"\",\n \"links\": [\n {\n \"rel\": \"\",\n \"href\": \"\"\n },\n {\n \"rel\": \"\",\n \"href\": \"\"\n }\n ]\n },\n {\n \"id\": \"\",\n \"issuer\": \"\",\n \"thumbprint\": \"\",\n \"expiration_date\": \"\",\n \"is_valid\": \"\",\n \"links\": [\n {\n \"rel\": \"\",\n \"href\": \"\"\n },\n {\n \"rel\": \"\",\n \"href\": \"\"\n }\n ]\n }\n ],\n \"attribute_mappings\": [\n {\n \"required_attribute_id\": \"\",\n \"required_attribute_name\": \"\",\n \"required_attribute_friendly_name\": \"\",\n \"substitute_attribute_name\": \"\"\n },\n {\n \"required_attribute_id\": \"\",\n \"required_attribute_name\": \"\",\n \"required_attribute_friendly_name\": \"\",\n \"substitute_attribute_name\": \"\"\n }\n ]\n },\n \"links\": [\n {\n \"rel\": \"\",\n \"href\": \"\"\n },\n {\n \"rel\": \"\",\n \"href\": \"\"\n }\n ]\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + } + ] + }, + { + "name": "ReservedDomains", + "description": "Methods to get a list of reserved domains.", + "item": [ { - "_postman_id": "ccc53a3f-efad-4ca5-9985-b42d8215593e", - "name": "Redacts membership and user data for users in an organization.", + "id": "2726aaa2-5880-43fe-9285-657534f1c381", + "name": "Returns the list of reserved domains for the organization.", "request": { + "name": "Returns the list of reserved domains for the organization.", + "description": { + "content": "Required scopes: domain_read", + "type": "text/markdown" + }, "url": { - "raw": "https://{{hostenv}}/Management/v2/data_redaction/organizations/{{organizationId}}/user", - "protocol": "https", - "auth": {}, - "host": [ - "{{hostenv}}" - ], "path": [ - "Management", "v2", - "data_redaction", "organizations", - "{{organizationId}}", - "user" + ":organizationId", + "reserved_domains" + ], + "host": [ + "{{baseUrl}}" ], + "query": [], "variable": [ { - "value": "{{organizationId}}", - "id": "organizationId" + "type": "any", + "value": "", + "key": "organizationId", + "disabled": false, + "description": { + "content": "(Required) The organization ID Guid", + "type": "text/plain" + } } ] }, - "method": "POST", "header": [ { "key": "Accept", - "value": "application/json", - "description": "" - }, - { - "key": "Content-Type", - "value": "application/json", - "description": "" - }, - { - "key": "Authorization", - "value": "Bearer {{accessToken}}", - "description": "" + "value": "application/json" } ], - "body": { - "mode": "raw", - "raw": "{}" - }, - "description": "Required scopes: user_data_redact" + "method": "GET", + "body": {}, + "auth": null }, - "response": [] - }, + "response": [ + { + "id": "a278e270-8178-4f2f-8d5e-c4ca3281bd36", + "name": "OK", + "originalRequest": { + "url": { + "path": [ + "v2", + "organizations", + ":organizationId", + "reserved_domains" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "GET", + "body": {} + }, + "status": "OK", + "code": 200, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"reserved_domains\": [\n {\n \"id\": \"\",\n \"status\": \"\",\n \"host_name\": \"\",\n \"txt_token\": \"\",\n \"identity_provider_id\": \"\",\n \"settings\": [\n {\n \"key\": \"\",\n \"value\": {},\n \"type\": \"\"\n },\n {\n \"key\": \"\",\n \"value\": {},\n \"type\": \"\"\n }\n ],\n \"links\": [\n {\n \"rel\": \"\",\n \"href\": \"\"\n },\n {\n \"rel\": \"\",\n \"href\": \"\"\n }\n ]\n },\n {\n \"id\": \"\",\n \"status\": \"\",\n \"host_name\": \"\",\n \"txt_token\": \"\",\n \"identity_provider_id\": \"\",\n \"settings\": [\n {\n \"key\": \"\",\n \"value\": {},\n \"type\": \"\"\n },\n {\n \"key\": \"\",\n \"value\": {},\n \"type\": \"\"\n }\n ],\n \"links\": [\n {\n \"rel\": \"\",\n \"href\": \"\"\n },\n {\n \"rel\": \"\",\n \"href\": \"\"\n }\n ]\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + } + ] + }, + { + "name": "Users", + "description": "Methods to manage users in an account.", + "item": [ { - "_postman_id": "313ac4b7-a417-45fd-a557-547e788aebc1", - "name": "Closes a user's memberships.", + "id": "b06984f8-c3b0-4ecb-bdbd-82ef0e064cad", + "name": "Updates a user's email address.", "request": { + "name": "Updates a user's email address.", + "description": { + "content": "Required scopes: user_write", + "type": "text/markdown" + }, "url": { - "raw": "https://{{hostenv}}/Management/v2/organizations/{{organizationId}}/users/{{userId}}/accounts", - "protocol": "https", - "auth": {}, - "host": [ - "{{hostenv}}" - ], "path": [ - "Management", "v2", "organizations", - "{{organizationId}}", + ":organizationId", "users", - "{{userId}}", - "accounts" + "email_addresses" + ], + "host": [ + "{{baseUrl}}" ], + "query": [], "variable": [ { - "value": "{{organizationId}}", - "id": "organizationId" - }, - { - "value": "{{userId}}", - "id": "userId" + "type": "any", + "value": "", + "key": "organizationId", + "disabled": false, + "description": { + "content": "(Required) The organization ID Guid", + "type": "text/plain" + } } ] }, - "method": "DELETE", "header": [ - { - "key": "Accept", - "value": "application/json", - "description": "" - }, { "key": "Content-Type", - "value": "application/json", - "description": "" + "value": "application/json" }, { - "key": "Authorization", - "value": "Bearer {{accessToken}}", - "description": "" + "key": "Accept", + "value": "application/json" } ], + "method": "POST", "body": { "mode": "raw", - "raw": "{}" + "raw": "{\n \"users\": [\n {\n \"id\": \"\",\n \"site_id\": \"\",\n \"email\": \"\"\n },\n {\n \"id\": \"\",\n \"site_id\": \"\",\n \"email\": \"\"\n }\n ]\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } }, - "description": "Required scopes: user_write" + "auth": null }, - "response": [] + "response": [ + { + "id": "8ab54c42-de88-48f6-8b03-aab37a30009f", + "name": "OK", + "originalRequest": { + "url": { + "path": [ + "v2", + "organizations", + ":organizationId", + "users", + "email_addresses" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"users\": [\n {\n \"id\": \"\",\n \"site_id\": \"\",\n \"email\": \"\"\n },\n {\n \"id\": \"\",\n \"site_id\": \"\",\n \"email\": \"\"\n }\n ]\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "OK", + "code": 200, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"success\": \"\",\n \"users\": [\n {\n \"id\": \"\",\n \"site_id\": \"\",\n \"email\": \"\",\n \"error_details\": {\n \"error\": \"\",\n \"error_description\": \"\"\n }\n },\n {\n \"id\": \"\",\n \"site_id\": \"\",\n \"email\": \"\",\n \"error_details\": {\n \"error\": \"\",\n \"error_description\": \"\"\n }\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } }, { - "_postman_id": "5b895655-75c7-4836-92d1-7816914eb367", + "id": "5b895655-75c7-4836-92d1-7816914eb367", "name": "Returns information about the users in the organization", "request": { + "name": "Returns information about the users in an organization.", + "description": { + "content": "Required scopes: user_read", + "type": "text/markdown" + }, "url": { - "raw": "https://{{hostenv}}/Management/v2/organizations/{{organizationId}}/users?start={{start}}&take={{take}}&end={{end}}&email={{email}}&email_user_name_like={{email_user_name_like}}&status={{status}}&membership_status={{membership_status}}&account_id={{account_id}}&organization_reserved_domain_id={{organization_reserved_domain_id}}&last_modified_since={{last_modified_since}}", - "protocol": "https", - "auth": {}, - "host": [ - "{{hostenv}}" - ], "path": [ - "Management", "v2", "organizations", - "{{organizationId}}", + ":organizationId", "users" ], + "host": [ + "{{baseUrl}}" + ], "query": [ { + "disabled": true, + "description": { + "content": "Index of first item to include in the response. The default value is 0.", + "type": "text/plain" + }, "key": "start", - "value": "{{start}}" + "value": "" }, { + "disabled": true, + "description": { + "content": "Page size of the response. The default value is 20.", + "type": "text/plain" + }, "key": "take", - "value": "{{take}}" + "value": "" }, { + "disabled": true, + "description": { + "content": "Index of the last item to include in the response. Ignored if `take` parameter is specified.", + "type": "text/plain" + }, "key": "end", - "value": "{{end}}" + "value": "" }, { + "disabled": true, + "description": { + "content": "Email address of the desired user. At least one of `email`, `account_id` or `organization_reserved_domain_id` must be specified.", + "type": "text/plain" + }, "key": "email", - "value": "{{email}}" + "value": "" }, { + "disabled": true, + "description": { + "content": "Selects users by pattern matching on the user's email address", + "type": "text/plain" + }, "key": "email_user_name_like", - "value": "{{email_user_name_like}}" + "value": "" }, { + "disabled": true, + "description": { + "content": "Status.", + "type": "text/plain" + }, "key": "status", - "value": "{{status}}" + "value": "" }, { + "disabled": true, + "description": { + "content": "The user's membership status. One of:\n\n- `activation_required`\n- `activation_sent`\n- `active`\n- `closed`\n- `disabled`\n", + "type": "text/plain" + }, "key": "membership_status", - "value": "{{membership_status}}" + "value": "" }, { + "disabled": true, + "description": { + "content": "Select users that are members of the specified account. At least one of `email`, `account_id` or `organization_reserved_domain_id` must be specified.", + "type": "text/plain" + }, "key": "account_id", - "value": "{{account_id}}" + "value": "" }, { + "disabled": true, + "description": { + "content": "Select users that are in the specified domain. At least one of `email`, `account_id` or `organization_reserved_domain_id` must be specified.", + "type": "text/plain" + }, "key": "organization_reserved_domain_id", - "value": "{{organization_reserved_domain_id}}" + "value": "" }, { + "disabled": true, + "description": { + "content": "Select users whose data have been modified since the date specified. `account_id` or `organization_reserved_domain_id` must be specified.", + "type": "text/plain" + }, "key": "last_modified_since", - "value": "{{last_modified_since}}" + "value": "" + }, + { + "disabled": true, + "description": { + "content": "Select users with groups the users belong to; The organization must have entitlement `AllowMultiApplication` enabled.", + "type": "text/plain" + }, + "key": "include_ds_groups", + "value": "" } ], "variable": [ { - "value": "{{organizationId}}", - "id": "organizationId" + "type": "any", + "value": "", + "key": "organizationId", + "disabled": false, + "description": { + "content": "(Required) The organization ID Guid", + "type": "text/plain" + } } ] }, - "method": "GET", "header": [ { "key": "Accept", - "value": "application/json", - "description": "" - }, - { - "key": "Content-Type", - "value": "application/json", - "description": "" - }, - { - "key": "Authorization", - "value": "Bearer {{accessToken}}", - "description": "" + "value": "application/json" } ], - "body": { - "mode": "raw", - "raw": "{}" - }, - "description": "Required scopes: user_read" + "method": "GET", + "body": {}, + "auth": null }, - "response": [] - }, + "response": [ + { + "id": "79d4630d-7072-40c8-86a9-6634966d4292", + "name": "OK", + "originalRequest": { + "url": { + "path": [ + "v2", + "organizations", + ":organizationId", + "users" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": true, + "description": { + "content": "Index of first item to include in the response. The default value is 0.", + "type": "text/plain" + }, + "key": "start", + "value": "" + }, + { + "disabled": true, + "description": { + "content": "Page size of the response. The default value is 20.", + "type": "text/plain" + }, + "key": "take", + "value": "" + }, + { + "disabled": true, + "description": { + "content": "Index of the last item to include in the response. Ignored if `take` parameter is specified.", + "type": "text/plain" + }, + "key": "end", + "value": "" + }, + { + "disabled": true, + "description": { + "content": "Email address of the desired user. At least one of `email`, `account_id` or `organization_reserved_domain_id` must be specified.", + "type": "text/plain" + }, + "key": "email", + "value": "" + }, + { + "disabled": true, + "description": { + "content": "Selects users by pattern matching on the user's email address", + "type": "text/plain" + }, + "key": "email_user_name_like", + "value": "" + }, + { + "disabled": true, + "description": { + "content": "Status.", + "type": "text/plain" + }, + "key": "status", + "value": "" + }, + { + "disabled": true, + "description": { + "content": "The user's membership status. One of:\n\n- `activation_required`\n- `activation_sent`\n- `active`\n- `closed`\n- `disabled`\n", + "type": "text/plain" + }, + "key": "membership_status", + "value": "" + }, + { + "disabled": true, + "description": { + "content": "Select users that are members of the specified account. At least one of `email`, `account_id` or `organization_reserved_domain_id` must be specified.", + "type": "text/plain" + }, + "key": "account_id", + "value": "" + }, + { + "disabled": true, + "description": { + "content": "Select users that are in the specified domain. At least one of `email`, `account_id` or `organization_reserved_domain_id` must be specified.", + "type": "text/plain" + }, + "key": "organization_reserved_domain_id", + "value": "" + }, + { + "disabled": true, + "description": { + "content": "Select users whose data have been modified since the date specified. `account_id` or `organization_reserved_domain_id` must be specified.", + "type": "text/plain" + }, + "key": "last_modified_since", + "value": "" + }, + { + "disabled": true, + "description": { + "content": "Select users with groups the users belong to; The organization must have entitlement `AllowMultiApplication` enabled.", + "type": "text/plain" + }, + "key": "include_ds_groups", + "value": "" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "GET", + "body": {} + }, + "status": "OK", + "code": 200, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"users\": [\n {\n \"id\": \"\",\n \"user_name\": \"\",\n \"first_name\": \"\",\n \"last_name\": \"\",\n \"user_status\": \"\",\n \"membership_status\": \"\",\n \"email\": \"\",\n \"created_on\": \"\",\n \"membership_created_on\": \"\",\n \"ds_groups\": [\n {\n \"ds_group_id\": \"\",\n \"account_id\": \"\",\n \"source_product_name\": \"\",\n \"group_id\": \"\",\n \"group_name\": \"\",\n \"description\": \"\",\n \"is_admin\": \"\",\n \"last_modified_on\": \"\",\n \"user_count\": \"\",\n \"external_account_id\": \"\",\n \"account_name\": \"\"\n },\n {\n \"ds_group_id\": \"\",\n \"account_id\": \"\",\n \"source_product_name\": \"\",\n \"group_id\": \"\",\n \"group_name\": \"\",\n \"description\": \"\",\n \"is_admin\": \"\",\n \"last_modified_on\": \"\",\n \"user_count\": \"\",\n \"external_account_id\": \"\",\n \"account_name\": \"\"\n }\n ],\n \"membership_id\": \"\"\n },\n {\n \"id\": \"\",\n \"user_name\": \"\",\n \"first_name\": \"\",\n \"last_name\": \"\",\n \"user_status\": \"\",\n \"membership_status\": \"\",\n \"email\": \"\",\n \"created_on\": \"\",\n \"membership_created_on\": \"\",\n \"ds_groups\": [\n {\n \"ds_group_id\": \"\",\n \"account_id\": \"\",\n \"source_product_name\": \"\",\n \"group_id\": \"\",\n \"group_name\": \"\",\n \"description\": \"\",\n \"is_admin\": \"\",\n \"last_modified_on\": \"\",\n \"user_count\": \"\",\n \"external_account_id\": \"\",\n \"account_name\": \"\"\n },\n {\n \"ds_group_id\": \"\",\n \"account_id\": \"\",\n \"source_product_name\": \"\",\n \"group_id\": \"\",\n \"group_name\": \"\",\n \"description\": \"\",\n \"is_admin\": \"\",\n \"last_modified_on\": \"\",\n \"user_count\": \"\",\n \"external_account_id\": \"\",\n \"account_name\": \"\"\n }\n ],\n \"membership_id\": \"\"\n }\n ],\n \"paging\": {\n \"result_set_size\": \"\",\n \"result_set_start_position\": \"\",\n \"result_set_end_position\": \"\",\n \"total_set_size\": \"\",\n \"next\": \"\",\n \"previous\": \"\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + } + ] + }, + { + "name": "eSignUserManagement", + "description": "Methods to manage eSignature users in an account.", + "item": [ { - "_postman_id": "d266760d-cc80-4ab7-8d94-4fcf27d7feb0", - "name": "Creates a new user", + "id": "c948f746-ee39-4a95-b6ac-abb394ffa4e6", + "name": "Returns the list of permission profiles in an account.", "request": { + "name": "Returns the list of permission profiles in an account.", + "description": { + "content": "Required scopes: permission_read", + "type": "text/markdown" + }, "url": { - "raw": "https://{{hostenv}}/Management/v2/organizations/{{organizationId}}/users", - "protocol": "https", - "auth": {}, - "host": [ - "{{hostenv}}" - ], "path": [ - "Management", "v2", "organizations", - "{{organizationId}}", - "users" + ":organizationId", + "accounts", + ":accountId", + "permissions" + ], + "host": [ + "{{baseUrl}}" ], + "query": [], "variable": [ { - "value": "{{organizationId}}", - "id": "organizationId" + "type": "any", + "value": "", + "key": "organizationId", + "disabled": false, + "description": { + "content": "(Required) The organization ID Guid", + "type": "text/plain" + } + }, + { + "type": "any", + "value": "", + "key": "accountId", + "disabled": false, + "description": { + "content": "(Required) The account ID Guid", + "type": "text/plain" + } } ] }, - "method": "POST", "header": [ { "key": "Accept", - "value": "application/json", - "description": "" - }, - { - "key": "Content-Type", - "value": "application/json", - "description": "" - }, - { - "key": "Authorization", - "value": "Bearer {{accessToken}}", - "description": "" + "value": "application/json" } ], - "body": { - "mode": "raw", - "raw": "{}" - }, - "description": "Required scopes: user_write" + "method": "GET", + "body": {}, + "auth": null }, - "response": [] + "response": [ + { + "id": "235647b9-a078-4e9c-b74e-b20079fb1a75", + "name": "OK", + "originalRequest": { + "url": { + "path": [ + "v2", + "organizations", + ":organizationId", + "accounts", + ":accountId", + "permissions" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "GET", + "body": {} + }, + "status": "OK", + "code": 200, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"permissions\": [\n {\n \"id\": \"\",\n \"name\": \"\"\n },\n {\n \"id\": \"\",\n \"name\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } }, { - "_postman_id": "02c8eb30-44fc-421a-a596-df4e9adc170c", - "name": "Activates user memberships", + "id": "d5161bbe-ca23-405e-9fa4-918bd4c87f76", + "name": "Returns the list of groups in an account.", "request": { + "name": "Returns the list of groups in an account.", + "description": { + "content": "Required scopes: group_read", + "type": "text/markdown" + }, "url": { - "raw": "https://{{hostenv}}/Management/v2/organizations/{{organizationId}}/users/{{userId}}/memberships/{{membershipId}}", - "protocol": "https", - "auth": {}, - "host": [ - "{{hostenv}}" - ], "path": [ - "Management", "v2", "organizations", - "{{organizationId}}", - "users", - "{{userId}}", - "memberships", - "{{membershipId}}" + ":organizationId", + "accounts", + ":accountId", + "groups" ], - "variable": [ + "host": [ + "{{baseUrl}}" + ], + "query": [ { - "value": "{{organizationId}}", - "id": "organizationId" + "disabled": true, + "description": { + "content": "Index of first item to include in the response. The default value is 0.", + "type": "text/plain" + }, + "key": "start", + "value": "" + }, + { + "disabled": true, + "description": { + "content": "Page size of the response. The default value is 20.", + "type": "text/plain" + }, + "key": "take", + "value": "" }, { - "value": "{{userId}}", - "id": "userId" + "disabled": true, + "description": { + "content": "Index of the last item to include in the response. Ignored if `take` parameter is specified.", + "type": "text/plain" + }, + "key": "end", + "value": "" + } + ], + "variable": [ + { + "type": "any", + "value": "", + "key": "organizationId", + "disabled": false, + "description": { + "content": "(Required) The organization ID Guid", + "type": "text/plain" + } }, { - "value": "{{membershipId}}", - "id": "membershipId" + "type": "any", + "value": "", + "key": "accountId", + "disabled": false, + "description": { + "content": "(Required) The account ID Guid", + "type": "text/plain" + } } ] }, - "method": "POST", "header": [ { "key": "Accept", - "value": "application/json", - "description": "" - }, - { - "key": "Content-Type", - "value": "application/json", - "description": "" - }, - { - "key": "Authorization", - "value": "Bearer {{accessToken}}", - "description": "" + "value": "application/json" } ], - "body": { - "mode": "raw", - "raw": "{}" - }, - "description": "Required scopes: user_write" + "method": "GET", + "body": {}, + "auth": null }, - "response": [] + "response": [ + { + "id": "9702ee01-aa67-4e79-8d36-91b941761b32", + "name": "OK", + "originalRequest": { + "url": { + "path": [ + "v2", + "organizations", + ":organizationId", + "accounts", + ":accountId", + "groups" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": true, + "description": { + "content": "Index of first item to include in the response. The default value is 0.", + "type": "text/plain" + }, + "key": "start", + "value": "" + }, + { + "disabled": true, + "description": { + "content": "Page size of the response. The default value is 20.", + "type": "text/plain" + }, + "key": "take", + "value": "" + }, + { + "disabled": true, + "description": { + "content": "Index of the last item to include in the response. Ignored if `take` parameter is specified.", + "type": "text/plain" + }, + "key": "end", + "value": "" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "GET", + "body": {} + }, + "status": "OK", + "code": 200, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"groups\": [\n {\n \"id\": \"\",\n \"name\": \"\",\n \"type\": \"\"\n },\n {\n \"id\": \"\",\n \"name\": \"\",\n \"type\": \"\"\n }\n ],\n \"paging\": {\n \"result_set_size\": \"\",\n \"result_set_start_position\": \"\",\n \"result_set_end_position\": \"\",\n \"total_set_size\": \"\",\n \"next\": \"\",\n \"previous\": \"\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } }, { - "_postman_id": "34bdae3c-7dad-4c83-b637-2e1291100806", - "name": "Returns user information.", + "id": "f7c6b50a-7ffa-4695-9c22-dfede9a068c6", + "name": "Updates a user.", "request": { + "name": "Updates a user's information.", + "description": { + "content": "Required scopes: user_write", + "type": "text/markdown" + }, "url": { - "raw": "https://{{hostenv}}/Management/v2/organizations/{{organizationId}}/users/profile?email={{email}}", - "protocol": "https", - "auth": {}, - "host": [ - "{{hostenv}}" - ], "path": [ - "Management", "v2", "organizations", - "{{organizationId}}", + ":organizationId", "users", - "profile" + "profiles" ], - "query": [ - { - "key": "email", - "value": "{{email}}" - } + "host": [ + "{{baseUrl}}" ], + "query": [], "variable": [ { - "value": "{{organizationId}}", - "id": "organizationId" + "type": "any", + "value": "", + "key": "organizationId", + "disabled": false, + "description": { + "content": "(Required) The organization ID Guid", + "type": "text/plain" + } } ] }, - "method": "GET", "header": [ - { - "key": "Accept", - "value": "application/json", - "description": "" - }, { "key": "Content-Type", - "value": "application/json", - "description": "" + "value": "application/json" }, { - "key": "Authorization", - "value": "Bearer {{accessToken}}", - "description": "" + "key": "Accept", + "value": "application/json" } ], + "method": "POST", "body": { "mode": "raw", - "raw": "{}" + "raw": "{\n \"users\": [\n {\n \"id\": \"\",\n \"site_id\": \"\",\n \"user_name\": \"\",\n \"first_name\": \"\",\n \"last_name\": \"\",\n \"email\": \"\",\n \"default_account_id\": \"\",\n \"language_culture\": \"\",\n \"selected_languages\": \"\",\n \"federated_status\": \"\",\n \"force_password_change\": \"\",\n \"memberships\": [\n {\n \"account_id\": \"\",\n \"permission_profile\": {\n \"id\": \"\",\n \"name\": \"\"\n },\n \"groups\": [\n {\n \"id\": \"\",\n \"name\": \"\",\n \"type\": \"\"\n },\n {\n \"id\": \"\",\n \"name\": \"\",\n \"type\": \"\"\n }\n ],\n \"company_name\": \"\",\n \"job_title\": \"\",\n \"send_activation\": \"\",\n \"access_code\": \"\"\n },\n {\n \"account_id\": \"\",\n \"permission_profile\": {\n \"id\": \"\",\n \"name\": \"\"\n },\n \"groups\": [\n {\n \"id\": \"\",\n \"name\": \"\",\n \"type\": \"\"\n },\n {\n \"id\": \"\",\n \"name\": \"\",\n \"type\": \"\"\n }\n ],\n \"company_name\": \"\",\n \"job_title\": \"\",\n \"send_activation\": \"\",\n \"access_code\": \"\"\n }\n ],\n \"device_verification_enabled\": \"\"\n },\n {\n \"id\": \"\",\n \"site_id\": \"\",\n \"user_name\": \"\",\n \"first_name\": \"\",\n \"last_name\": \"\",\n \"email\": \"\",\n \"default_account_id\": \"\",\n \"language_culture\": \"\",\n \"selected_languages\": \"\",\n \"federated_status\": \"\",\n \"force_password_change\": \"\",\n \"memberships\": [\n {\n \"account_id\": \"\",\n \"permission_profile\": {\n \"id\": \"\",\n \"name\": \"\"\n },\n \"groups\": [\n {\n \"id\": \"\",\n \"name\": \"\",\n \"type\": \"\"\n },\n {\n \"id\": \"\",\n \"name\": \"\",\n \"type\": \"\"\n }\n ],\n \"company_name\": \"\",\n \"job_title\": \"\",\n \"send_activation\": \"\",\n \"access_code\": \"\"\n },\n {\n \"account_id\": \"\",\n \"permission_profile\": {\n \"id\": \"\",\n \"name\": \"\"\n },\n \"groups\": [\n {\n \"id\": \"\",\n \"name\": \"\",\n \"type\": \"\"\n },\n {\n \"id\": \"\",\n \"name\": \"\",\n \"type\": \"\"\n }\n ],\n \"company_name\": \"\",\n \"job_title\": \"\",\n \"send_activation\": \"\",\n \"access_code\": \"\"\n }\n ],\n \"device_verification_enabled\": \"\"\n }\n ]\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } }, - "description": "Required scopes: user_read" + "auth": null }, - "response": [] + "response": [ + { + "id": "464885ec-cea6-4110-a4be-42794babc251", + "name": "OK", + "originalRequest": { + "url": { + "path": [ + "v2", + "organizations", + ":organizationId", + "users", + "profiles" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"users\": [\n {\n \"id\": \"\",\n \"site_id\": \"\",\n \"user_name\": \"\",\n \"first_name\": \"\",\n \"last_name\": \"\",\n \"email\": \"\",\n \"default_account_id\": \"\",\n \"language_culture\": \"\",\n \"selected_languages\": \"\",\n \"federated_status\": \"\",\n \"force_password_change\": \"\",\n \"memberships\": [\n {\n \"account_id\": \"\",\n \"permission_profile\": {\n \"id\": \"\",\n \"name\": \"\"\n },\n \"groups\": [\n {\n \"id\": \"\",\n \"name\": \"\",\n \"type\": \"\"\n },\n {\n \"id\": \"\",\n \"name\": \"\",\n \"type\": \"\"\n }\n ],\n \"company_name\": \"\",\n \"job_title\": \"\",\n \"send_activation\": \"\",\n \"access_code\": \"\"\n },\n {\n \"account_id\": \"\",\n \"permission_profile\": {\n \"id\": \"\",\n \"name\": \"\"\n },\n \"groups\": [\n {\n \"id\": \"\",\n \"name\": \"\",\n \"type\": \"\"\n },\n {\n \"id\": \"\",\n \"name\": \"\",\n \"type\": \"\"\n }\n ],\n \"company_name\": \"\",\n \"job_title\": \"\",\n \"send_activation\": \"\",\n \"access_code\": \"\"\n }\n ],\n \"device_verification_enabled\": \"\"\n },\n {\n \"id\": \"\",\n \"site_id\": \"\",\n \"user_name\": \"\",\n \"first_name\": \"\",\n \"last_name\": \"\",\n \"email\": \"\",\n \"default_account_id\": \"\",\n \"language_culture\": \"\",\n \"selected_languages\": \"\",\n \"federated_status\": \"\",\n \"force_password_change\": \"\",\n \"memberships\": [\n {\n \"account_id\": \"\",\n \"permission_profile\": {\n \"id\": \"\",\n \"name\": \"\"\n },\n \"groups\": [\n {\n \"id\": \"\",\n \"name\": \"\",\n \"type\": \"\"\n },\n {\n \"id\": \"\",\n \"name\": \"\",\n \"type\": \"\"\n }\n ],\n \"company_name\": \"\",\n \"job_title\": \"\",\n \"send_activation\": \"\",\n \"access_code\": \"\"\n },\n {\n \"account_id\": \"\",\n \"permission_profile\": {\n \"id\": \"\",\n \"name\": \"\"\n },\n \"groups\": [\n {\n \"id\": \"\",\n \"name\": \"\",\n \"type\": \"\"\n },\n {\n \"id\": \"\",\n \"name\": \"\",\n \"type\": \"\"\n }\n ],\n \"company_name\": \"\",\n \"job_title\": \"\",\n \"send_activation\": \"\",\n \"access_code\": \"\"\n }\n ],\n \"device_verification_enabled\": \"\"\n }\n ]\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "OK", + "code": 200, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"success\": \"\",\n \"users\": [\n {\n \"id\": \"\",\n \"site_id\": \"\",\n \"email\": \"\",\n \"error_details\": {\n \"error\": \"\",\n \"error_description\": \"\"\n }\n },\n {\n \"id\": \"\",\n \"site_id\": \"\",\n \"email\": \"\",\n \"error_details\": {\n \"error\": \"\",\n \"error_description\": \"\"\n }\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } }, { - "_postman_id": "9d4188ed-c230-4535-adb0-c1d9757b981d", - "name": "Deletes user identities.", + "id": "313ac4b7-a417-45fd-a557-547e788aebc1", + "name": "Closes a user's memberships.", "request": { + "name": "Closes a user's memberships.", + "description": { + "content": "Required scopes: user_write", + "type": "text/markdown" + }, "url": { - "raw": "https://{{hostenv}}/Management/v2/organizations/{{organizationId}}/users/{{userId}}/identities", - "protocol": "https", - "auth": {}, - "host": [ - "{{hostenv}}" - ], "path": [ - "Management", "v2", "organizations", - "{{organizationId}}", + ":organizationId", "users", - "{{userId}}", - "identities" + ":userId", + "accounts" + ], + "host": [ + "{{baseUrl}}" ], + "query": [], "variable": [ { - "value": "{{organizationId}}", - "id": "organizationId" + "type": "any", + "value": "", + "key": "organizationId", + "disabled": false, + "description": { + "content": "(Required) The organization ID Guid", + "type": "text/plain" + } }, { - "value": "{{userId}}", - "id": "userId" + "type": "any", + "value": "", + "key": "userId", + "disabled": false, + "description": { + "content": "(Required) The user ID Guid", + "type": "text/plain" + } } ] }, - "method": "DELETE", "header": [ - { - "key": "Accept", - "value": "application/json", - "description": "" - }, { "key": "Content-Type", - "value": "application/json", - "description": "" + "value": "application/json" }, { - "key": "Authorization", - "value": "Bearer {{accessToken}}", - "description": "" + "key": "Accept", + "value": "application/json" } ], + "method": "DELETE", "body": { "mode": "raw", - "raw": "{}" + "raw": "{\n \"accounts\": [\n {\n \"id\": \"\"\n },\n {\n \"id\": \"\"\n }\n ]\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } }, - "description": "Required scopes: user_write" + "auth": null }, - "response": [] + "response": [ + { + "id": "da163c97-4cb0-449d-a40d-3c51ecdd51b5", + "name": "OK", + "originalRequest": { + "url": { + "path": [ + "v2", + "organizations", + ":organizationId", + "users", + ":userId", + "accounts" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "DELETE", + "body": { + "mode": "raw", + "raw": "{\n \"accounts\": [\n {\n \"id\": \"\"\n },\n {\n \"id\": \"\"\n }\n ]\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "OK", + "code": 200, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"success\": \"\",\n \"accounts\": [\n {\n \"id\": \"\",\n \"error_details\": {\n \"error\": \"\",\n \"error_description\": \"\"\n }\n },\n {\n \"id\": \"\",\n \"error_details\": {\n \"error\": \"\",\n \"error_description\": \"\"\n }\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } }, { - "_postman_id": "17b7aa45-054e-4a1d-b13e-a8ec29a372fa", - "name": "Adds users to an account.", + "id": "d266760d-cc80-4ab7-8d94-4fcf27d7feb0", + "name": "Creates a new user", "request": { + "name": "Creates a new eSignature user.", + "description": { + "content": "Required scopes: user_write", + "type": "text/markdown" + }, "url": { - "raw": "https://{{hostenv}}/Management/v2/organizations/{{organizationId}}/accounts/{{accountId}}/users", - "protocol": "https", - "auth": {}, - "host": [ - "{{hostenv}}" - ], "path": [ - "Management", "v2", "organizations", - "{{organizationId}}", - "accounts", - "{{accountId}}", + ":organizationId", "users" ], + "host": [ + "{{baseUrl}}" + ], + "query": [], "variable": [ { - "value": "{{organizationId}}", - "id": "organizationId" - }, - { - "value": "{{accountId}}", - "id": "accountId" + "type": "any", + "value": "", + "key": "organizationId", + "disabled": false, + "description": { + "content": "(Required) The organization ID Guid", + "type": "text/plain" + } } ] }, - "method": "POST", "header": [ - { - "key": "Accept", - "value": "application/json", - "description": "" - }, { "key": "Content-Type", - "value": "application/json", - "description": "" + "value": "application/json" }, { - "key": "Authorization", - "value": "Bearer {{accessToken}}", - "description": "" + "key": "Accept", + "value": "application/json" } ], + "method": "POST", "body": { "mode": "raw", - "raw": "{}" + "raw": "{\n \"accounts\": [\n {\n \"id\": \"\",\n \"permission_profile\": {\n \"id\": \"\",\n \"name\": \"\"\n },\n \"groups\": [\n {\n \"id\": \"\",\n \"name\": \"\",\n \"type\": \"\"\n },\n {\n \"id\": \"\",\n \"name\": \"\",\n \"type\": \"\"\n }\n ],\n \"company_name\": \"\",\n \"job_title\": \"\"\n },\n {\n \"id\": \"\",\n \"permission_profile\": {\n \"id\": \"\",\n \"name\": \"\"\n },\n \"groups\": [\n {\n \"id\": \"\",\n \"name\": \"\",\n \"type\": \"\"\n },\n {\n \"id\": \"\",\n \"name\": \"\",\n \"type\": \"\"\n }\n ],\n \"company_name\": \"\",\n \"job_title\": \"\"\n }\n ],\n \"email\": \"\",\n \"user_name\": \"\",\n \"first_name\": \"\",\n \"last_name\": \"\",\n \"default_account_id\": \"\",\n \"language_culture\": \"\",\n \"selected_languages\": \"\",\n \"access_code\": \"\",\n \"federated_status\": \"\",\n \"auto_activate_memberships\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } }, - "description": "Required scopes: user_write" + "auth": null }, - "response": [] + "response": [ + { + "id": "d9dc2805-8f5a-40e2-9cc3-8813f06c545a", + "name": "OK", + "originalRequest": { + "url": { + "path": [ + "v2", + "organizations", + ":organizationId", + "users" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"accounts\": [\n {\n \"id\": \"\",\n \"permission_profile\": {\n \"id\": \"\",\n \"name\": \"\"\n },\n \"groups\": [\n {\n \"id\": \"\",\n \"name\": \"\",\n \"type\": \"\"\n },\n {\n \"id\": \"\",\n \"name\": \"\",\n \"type\": \"\"\n }\n ],\n \"company_name\": \"\",\n \"job_title\": \"\"\n },\n {\n \"id\": \"\",\n \"permission_profile\": {\n \"id\": \"\",\n \"name\": \"\"\n },\n \"groups\": [\n {\n \"id\": \"\",\n \"name\": \"\",\n \"type\": \"\"\n },\n {\n \"id\": \"\",\n \"name\": \"\",\n \"type\": \"\"\n }\n ],\n \"company_name\": \"\",\n \"job_title\": \"\"\n }\n ],\n \"email\": \"\",\n \"user_name\": \"\",\n \"first_name\": \"\",\n \"last_name\": \"\",\n \"default_account_id\": \"\",\n \"language_culture\": \"\",\n \"selected_languages\": \"\",\n \"access_code\": \"\",\n \"federated_status\": \"\",\n \"auto_activate_memberships\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "OK", + "code": 200, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"id\": \"\",\n \"site_id\": \"\",\n \"user_name\": \"\",\n \"first_name\": \"\",\n \"last_name\": \"\",\n \"email\": \"\",\n \"language_culture\": \"\",\n \"federated_status\": \"\",\n \"accounts\": [\n {\n \"id\": \"\",\n \"site_id\": \"\",\n \"permission_profile\": {\n \"id\": \"\",\n \"name\": \"\"\n },\n \"groups\": [\n {\n \"id\": \"\",\n \"name\": \"\",\n \"type\": \"\"\n },\n {\n \"id\": \"\",\n \"name\": \"\",\n \"type\": \"\"\n }\n ],\n \"company_name\": \"\",\n \"job_title\": \"\"\n },\n {\n \"id\": \"\",\n \"site_id\": \"\",\n \"permission_profile\": {\n \"id\": \"\",\n \"name\": \"\"\n },\n \"groups\": [\n {\n \"id\": \"\",\n \"name\": \"\",\n \"type\": \"\"\n },\n {\n \"id\": \"\",\n \"name\": \"\",\n \"type\": \"\"\n }\n ],\n \"company_name\": \"\",\n \"job_title\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } }, { - "_postman_id": "523610d2-2774-41fe-8648-2992caa076e6", - "name": "Get list of DSGroups", + "id": "02c8eb30-44fc-421a-a596-df4e9adc170c", + "name": "Activates user memberships", "request": { + "name": "Activates user memberships.", + "description": { + "content": "Required scopes: user_write", + "type": "text/markdown" + }, "url": { - "raw": "https://{{hostenv}}/Management/v2.1/organizations/{{organizationId}}/accounts/{{accountId}}/dsgroups?page={{page}}&page_size={{page_size}}", - "protocol": "https", - "auth": {}, - "host": [ - "{{hostenv}}" - ], "path": [ - "Management", - "v2.1", + "v2", "organizations", - "{{organizationId}}", - "accounts", - "{{accountId}}", - "dsgroups" + ":organizationId", + "users", + ":userId", + "memberships", + ":membershipId" ], - "query": [ - { - "key": "page", - "value": "{{page}}" - }, - { - "key": "page_size", - "value": "{{page_size}}" - } + "host": [ + "{{baseUrl}}" ], + "query": [], "variable": [ { - "value": "{{organizationId}}", - "id": "organizationId" + "type": "any", + "value": "", + "key": "organizationId", + "disabled": false, + "description": { + "content": "(Required) The organization ID Guid", + "type": "text/plain" + } + }, + { + "type": "any", + "value": "", + "key": "userId", + "disabled": false, + "description": { + "content": "(Required) The user ID Guid", + "type": "text/plain" + } }, { - "value": "{{accountId}}", - "id": "accountId" + "type": "any", + "value": "", + "key": "membershipId", + "disabled": false, + "description": { + "content": "(Required) The membership ID GUID.", + "type": "text/plain" + } } ] }, - "method": "GET", "header": [ - { - "key": "Accept", - "value": "application/json", - "description": "" - }, { "key": "Content-Type", - "value": "application/json", - "description": "" + "value": "application/json" }, { - "key": "Authorization", - "value": "Bearer {{accessToken}}", - "description": "" + "key": "Accept", + "value": "application/json" } ], + "method": "POST", "body": { "mode": "raw", - "raw": "{}" + "raw": "{\n \"site_id\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } }, - "description": "Required scopes: user_read" + "auth": null }, - "response": [] + "response": [ + { + "id": "dcda6abc-43ff-452a-9df0-57c785d0e406", + "name": "OK", + "originalRequest": { + "url": { + "path": [ + "v2", + "organizations", + ":organizationId", + "users", + ":userId", + "memberships", + ":membershipId" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"site_id\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "OK", + "code": 200, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"status\": \"\"\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } }, { - "_postman_id": "73e83ede-b896-444d-8e43-dadc4fc5a4b3", - "name": "Add a new DSGroup", + "id": "34bdae3c-7dad-4c83-b637-2e1291100806", + "name": "Returns user information.", "request": { + "name": "Returns historical information about users with a specific email address.\n", + "description": { + "content": "Required scopes: user_read", + "type": "text/markdown" + }, "url": { - "raw": "https://{{hostenv}}/Management/v2.1/organizations/{{organizationId}}/accounts/{{accountId}}/dsgroups", - "protocol": "https", - "auth": {}, - "host": [ - "{{hostenv}}" - ], "path": [ - "Management", - "v2.1", + "v2", "organizations", - "{{organizationId}}", - "accounts", - "{{accountId}}", - "dsgroups" + ":organizationId", + "users", + "profile" ], - "variable": [ + "host": [ + "{{baseUrl}}" + ], + "query": [ { - "value": "{{organizationId}}", - "id": "organizationId" - }, + "disabled": true, + "description": { + "content": "The email address associated with the users you want to retrieve.\n\n**Note:** This property is required.", + "type": "text/plain" + }, + "key": "email", + "value": "" + } + ], + "variable": [ { - "value": "{{accountId}}", - "id": "accountId" + "type": "any", + "value": "", + "key": "organizationId", + "disabled": false, + "description": { + "content": "(Required) The organization ID Guid", + "type": "text/plain" + } } ] }, - "method": "POST", "header": [ { "key": "Accept", - "value": "application/json", - "description": "" - }, - { - "key": "Content-Type", - "value": "application/json", - "description": "" - }, - { - "key": "Authorization", - "value": "Bearer {{accessToken}}", - "description": "" + "value": "application/json" } ], - "body": { - "mode": "raw", - "raw": "{}" - }, - "description": "Required scopes: user_write" + "method": "GET", + "body": {}, + "auth": null }, - "response": [] + "response": [ + { + "id": "1d970289-3ea0-4f02-8b80-011204546886", + "name": "OK", + "originalRequest": { + "url": { + "path": [ + "v2", + "organizations", + ":organizationId", + "users", + "profile" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": true, + "description": { + "content": "The email address associated with the users you want to retrieve.\n\n**Note:** This property is required.", + "type": "text/plain" + }, + "key": "email", + "value": "" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "GET", + "body": {} + }, + "status": "OK", + "code": 200, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"users\": [\n {\n \"id\": \"\",\n \"site_id\": \"\",\n \"site_name\": \"\",\n \"user_name\": \"\",\n \"first_name\": \"\",\n \"last_name\": \"\",\n \"user_status\": \"\",\n \"default_account_id\": \"\",\n \"default_account_name\": \"\",\n \"language_culture\": \"\",\n \"selected_languages\": \"\",\n \"federated_status\": \"\",\n \"is_organization_admin\": \"\",\n \"created_on\": \"\",\n \"last_login\": \"\",\n \"memberships\": [\n {\n \"email\": \"\",\n \"account_id\": \"\",\n \"external_account_id\": \"\",\n \"account_name\": \"\",\n \"is_external_account\": \"\",\n \"status\": \"\",\n \"permission_profile\": {\n \"id\": \"\",\n \"name\": \"\"\n },\n \"created_on\": \"\",\n \"groups\": [\n {\n \"id\": \"\",\n \"name\": \"\",\n \"type\": \"\"\n },\n {\n \"id\": \"\",\n \"name\": \"\",\n \"type\": \"\"\n }\n ],\n \"is_admin\": \"\"\n },\n {\n \"email\": \"\",\n \"account_id\": \"\",\n \"external_account_id\": \"\",\n \"account_name\": \"\",\n \"is_external_account\": \"\",\n \"status\": \"\",\n \"permission_profile\": {\n \"id\": \"\",\n \"name\": \"\"\n },\n \"created_on\": \"\",\n \"groups\": [\n {\n \"id\": \"\",\n \"name\": \"\",\n \"type\": \"\"\n },\n {\n \"id\": \"\",\n \"name\": \"\",\n \"type\": \"\"\n }\n ],\n \"is_admin\": \"\"\n }\n ],\n \"identities\": [\n {\n \"id\": \"\",\n \"provider_id\": \"\",\n \"user_id\": \"\",\n \"immutable_id\": \"\",\n \"error_details\": {\n \"error\": \"\",\n \"error_description\": \"\"\n }\n },\n {\n \"id\": \"\",\n \"provider_id\": \"\",\n \"user_id\": \"\",\n \"immutable_id\": \"\",\n \"error_details\": {\n \"error\": \"\",\n \"error_description\": \"\"\n }\n }\n ],\n \"device_verification_enabled\": \"\"\n },\n {\n \"id\": \"\",\n \"site_id\": \"\",\n \"site_name\": \"\",\n \"user_name\": \"\",\n \"first_name\": \"\",\n \"last_name\": \"\",\n \"user_status\": \"\",\n \"default_account_id\": \"\",\n \"default_account_name\": \"\",\n \"language_culture\": \"\",\n \"selected_languages\": \"\",\n \"federated_status\": \"\",\n \"is_organization_admin\": \"\",\n \"created_on\": \"\",\n \"last_login\": \"\",\n \"memberships\": [\n {\n \"email\": \"\",\n \"account_id\": \"\",\n \"external_account_id\": \"\",\n \"account_name\": \"\",\n \"is_external_account\": \"\",\n \"status\": \"\",\n \"permission_profile\": {\n \"id\": \"\",\n \"name\": \"\"\n },\n \"created_on\": \"\",\n \"groups\": [\n {\n \"id\": \"\",\n \"name\": \"\",\n \"type\": \"\"\n },\n {\n \"id\": \"\",\n \"name\": \"\",\n \"type\": \"\"\n }\n ],\n \"is_admin\": \"\"\n },\n {\n \"email\": \"\",\n \"account_id\": \"\",\n \"external_account_id\": \"\",\n \"account_name\": \"\",\n \"is_external_account\": \"\",\n \"status\": \"\",\n \"permission_profile\": {\n \"id\": \"\",\n \"name\": \"\"\n },\n \"created_on\": \"\",\n \"groups\": [\n {\n \"id\": \"\",\n \"name\": \"\",\n \"type\": \"\"\n },\n {\n \"id\": \"\",\n \"name\": \"\",\n \"type\": \"\"\n }\n ],\n \"is_admin\": \"\"\n }\n ],\n \"identities\": [\n {\n \"id\": \"\",\n \"provider_id\": \"\",\n \"user_id\": \"\",\n \"immutable_id\": \"\",\n \"error_details\": {\n \"error\": \"\",\n \"error_description\": \"\"\n }\n },\n {\n \"id\": \"\",\n \"provider_id\": \"\",\n \"user_id\": \"\",\n \"immutable_id\": \"\",\n \"error_details\": {\n \"error\": \"\",\n \"error_description\": \"\"\n }\n }\n ],\n \"device_verification_enabled\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } }, { - "_postman_id": "00be6c28-ce9f-4706-a034-fc4f65b29bd7", - "name": "Get list of DSGroup", + "id": "9d4188ed-c230-4535-adb0-c1d9757b981d", + "name": "Deletes user identities.", "request": { + "name": "Delete user identities for a specified identity provider.", + "description": { + "content": "Required scopes: user_write", + "type": "text/markdown" + }, "url": { - "raw": "https://{{hostenv}}/Management/v2.1/organizations/{{organizationId}}/accounts/{{accountId}}/dsgroups/{{dsGroupId}}", - "protocol": "https", - "auth": {}, - "host": [ - "{{hostenv}}" - ], "path": [ - "Management", - "v2.1", + "v2", "organizations", - "{{organizationId}}", - "accounts", - "{{accountId}}", - "dsgroups", - "{{dsGroupId}}" + ":organizationId", + "users", + ":userId", + "identities" ], + "host": [ + "{{baseUrl}}" + ], + "query": [], "variable": [ { - "value": "{{organizationId}}", - "id": "organizationId" - }, - { - "value": "{{accountId}}", - "id": "accountId" + "type": "any", + "value": "", + "key": "organizationId", + "disabled": false, + "description": { + "content": "(Required) The organization GUID.", + "type": "text/plain" + } }, { - "value": "{{dsGroupId}}", - "id": "dsGroupId" + "type": "any", + "value": "", + "key": "userId", + "disabled": false, + "description": { + "content": "(Required) The ID of the user to access.", + "type": "text/plain" + } } ] }, - "method": "GET", "header": [ - { - "key": "Accept", - "value": "application/json", - "description": "" - }, { "key": "Content-Type", - "value": "application/json", - "description": "" + "value": "application/json" }, { - "key": "Authorization", - "value": "Bearer {{accessToken}}", - "description": "" + "key": "Accept", + "value": "application/json" } ], + "method": "DELETE", "body": { "mode": "raw", - "raw": "{}" + "raw": "{\n \"identities\": [\n {\n \"id\": \"\"\n },\n {\n \"id\": \"\"\n }\n ]\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } }, - "description": "Required scopes: user_read" + "auth": null }, - "response": [] + "response": [ + { + "id": "9eabfa4d-2074-477a-98e9-2c51be1988c4", + "name": "OK", + "originalRequest": { + "url": { + "path": [ + "v2", + "organizations", + ":organizationId", + "users", + ":userId", + "identities" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "DELETE", + "body": { + "mode": "raw", + "raw": "{\n \"identities\": [\n {\n \"id\": \"\"\n },\n {\n \"id\": \"\"\n }\n ]\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "OK", + "code": 200, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"success\": \"\",\n \"identities\": [\n {\n \"id\": \"\",\n \"provider_id\": \"\",\n \"user_id\": \"\",\n \"immutable_id\": \"\",\n \"error_details\": {\n \"error\": \"\",\n \"error_description\": \"\"\n }\n },\n {\n \"id\": \"\",\n \"provider_id\": \"\",\n \"user_id\": \"\",\n \"immutable_id\": \"\",\n \"error_details\": {\n \"error\": \"\",\n \"error_description\": \"\"\n }\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } }, { - "_postman_id": "ef9b82c0-a4ee-4917-8964-deb3152a6616", - "name": "Delete a DSGroup", + "id": "17b7aa45-054e-4a1d-b13e-a8ec29a372fa", + "name": "Adds users to an account.", "request": { + "name": "Adds users to an account.", + "description": { + "content": "Required scopes: user_write", + "type": "text/markdown" + }, "url": { - "raw": "https://{{hostenv}}/Management/v2.1/organizations/{{organizationId}}/accounts/{{accountId}}/dsgroups/{{dsGroupId}}", - "protocol": "https", - "auth": {}, - "host": [ - "{{hostenv}}" - ], "path": [ - "Management", - "v2.1", + "v2", "organizations", - "{{organizationId}}", + ":organizationId", "accounts", - "{{accountId}}", - "dsgroups", - "{{dsGroupId}}" + ":accountId", + "users" + ], + "host": [ + "{{baseUrl}}" ], + "query": [], "variable": [ { - "value": "{{organizationId}}", - "id": "organizationId" - }, - { - "value": "{{accountId}}", - "id": "accountId" + "type": "any", + "value": "", + "key": "organizationId", + "disabled": false, + "description": { + "content": "(Required) The organization ID Guid", + "type": "text/plain" + } }, { - "value": "{{dsGroupId}}", - "id": "dsGroupId" + "type": "any", + "value": "", + "key": "accountId", + "disabled": false, + "description": { + "content": "(Required) The account ID Guid", + "type": "text/plain" + } } ] }, - "method": "DELETE", "header": [ - { - "key": "Accept", - "value": "application/json", - "description": "" - }, { "key": "Content-Type", - "value": "application/json", - "description": "" + "value": "application/json" }, { - "key": "Authorization", - "value": "Bearer {{accessToken}}", - "description": "" + "key": "Accept", + "value": "application/json" } ], + "method": "POST", "body": { "mode": "raw", - "raw": "{}" + "raw": "{\n \"email\": \"\",\n \"permission_profile\": {\n \"id\": \"\",\n \"name\": \"\"\n },\n \"groups\": [\n {\n \"id\": \"\",\n \"name\": \"\",\n \"type\": \"\"\n },\n {\n \"id\": \"\",\n \"name\": \"\",\n \"type\": \"\"\n }\n ],\n \"user_name\": \"\",\n \"first_name\": \"\",\n \"last_name\": \"\",\n \"default_account_id\": \"\",\n \"language_culture\": \"\",\n \"selected_languages\": \"\",\n \"access_code\": \"\",\n \"federated_status\": \"\",\n \"auto_activate_memberships\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } }, - "description": "Required scopes: user_write" + "auth": null }, - "response": [] - }, + "response": [ + { + "id": "7ff06ce0-b7a4-44d3-940f-dc7038cf7cf3", + "name": "OK", + "originalRequest": { + "url": { + "path": [ + "v2", + "organizations", + ":organizationId", + "accounts", + ":accountId", + "users" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"email\": \"\",\n \"permission_profile\": {\n \"id\": \"\",\n \"name\": \"\"\n },\n \"groups\": [\n {\n \"id\": \"\",\n \"name\": \"\",\n \"type\": \"\"\n },\n {\n \"id\": \"\",\n \"name\": \"\",\n \"type\": \"\"\n }\n ],\n \"user_name\": \"\",\n \"first_name\": \"\",\n \"last_name\": \"\",\n \"default_account_id\": \"\",\n \"language_culture\": \"\",\n \"selected_languages\": \"\",\n \"access_code\": \"\",\n \"federated_status\": \"\",\n \"auto_activate_memberships\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "OK", + "code": 200, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"id\": \"\",\n \"site_id\": \"\",\n \"user_name\": \"\",\n \"first_name\": \"\",\n \"last_name\": \"\",\n \"email\": \"\",\n \"language_culture\": \"\",\n \"federated_status\": \"\",\n \"accounts\": [\n {\n \"id\": \"\",\n \"site_id\": \"\",\n \"permission_profile\": {\n \"id\": \"\",\n \"name\": \"\"\n },\n \"groups\": [\n {\n \"id\": \"\",\n \"name\": \"\",\n \"type\": \"\"\n },\n {\n \"id\": \"\",\n \"name\": \"\",\n \"type\": \"\"\n }\n ],\n \"company_name\": \"\",\n \"job_title\": \"\"\n },\n {\n \"id\": \"\",\n \"site_id\": \"\",\n \"permission_profile\": {\n \"id\": \"\",\n \"name\": \"\"\n },\n \"groups\": [\n {\n \"id\": \"\",\n \"name\": \"\",\n \"type\": \"\"\n },\n {\n \"id\": \"\",\n \"name\": \"\",\n \"type\": \"\"\n }\n ],\n \"company_name\": \"\",\n \"job_title\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + } + ] + }, + { + "name": "MultiProductUserManagement", + "description": "Methods to manage multi-product users in an account.", + "item": [ { - "_postman_id": "fdff0094-197d-4cf0-82c0-f56561fad43a", - "name": "Get list of users in a DSGroup", + "id": "523610d2-2774-41fe-8648-2992caa076e6", + "name": "Get list of DSGroups", "request": { + "name": "Returns a list of DSGroups.", + "description": { + "content": "Required scopes: user_read", + "type": "text/markdown" + }, "url": { - "raw": "https://{{hostenv}}/Management/v2.1/organizations/{{organizationId}}/accounts/{{accountId}}/dsgroups/{{dsGroupId}}/users?page={{page}}&page_size={{page_size}}", - "protocol": "https", - "auth": {}, - "host": [ - "{{hostenv}}" - ], "path": [ - "Management", "v2.1", "organizations", - "{{organizationId}}", + ":organizationId", "accounts", - "{{accountId}}", - "dsgroups", - "{{dsGroupId}}", - "users" + ":accountId", + "dsgroups" + ], + "host": [ + "{{baseUrl}}" ], "query": [ { + "disabled": true, + "description": { + "content": "Start page of DSGroups.", + "type": "text/plain" + }, "key": "page", - "value": "{{page}}" + "value": "" }, { + "disabled": true, + "description": { + "content": "Page size of DSGroups.", + "type": "text/plain" + }, "key": "page_size", - "value": "{{page_size}}" + "value": "" } ], "variable": [ { - "value": "{{organizationId}}", - "id": "organizationId" - }, - { - "value": "{{accountId}}", - "id": "accountId" + "type": "any", + "value": "", + "key": "organizationId", + "disabled": false, + "description": { + "content": "(Required) The organization ID GUID", + "type": "text/plain" + } }, { - "value": "{{dsGroupId}}", - "id": "dsGroupId" + "type": "any", + "value": "", + "key": "accountId", + "disabled": false, + "description": { + "content": "(Required) The account ID GUID.", + "type": "text/plain" + } } ] }, - "method": "GET", "header": [ { "key": "Accept", - "value": "application/json", - "description": "" - }, - { - "key": "Content-Type", - "value": "application/json", - "description": "" - }, - { - "key": "Authorization", - "value": "Bearer {{accessToken}}", - "description": "" + "value": "application/json" } ], - "body": { - "mode": "raw", - "raw": "{}" - }, - "description": "Required scopes: user_read" + "method": "GET", + "body": {}, + "auth": null }, - "response": [] + "response": [ + { + "id": "d04548ff-7bbe-4224-b8ee-94e1b531b634", + "name": "OK", + "originalRequest": { + "url": { + "path": [ + "v2.1", + "organizations", + ":organizationId", + "accounts", + ":accountId", + "dsgroups" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": true, + "description": { + "content": "Start page of DSGroups.", + "type": "text/plain" + }, + "key": "page", + "value": "" + }, + { + "disabled": true, + "description": { + "content": "Page size of DSGroups.", + "type": "text/plain" + }, + "key": "page_size", + "value": "" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "GET", + "body": {} + }, + "status": "OK", + "code": 200, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"page\": \"\",\n \"page_size\": \"\",\n \"total_count\": \"\",\n \"account_id\": \"\",\n \"ds_groups\": [\n {\n \"ds_group_id\": \"\",\n \"account_id\": \"\",\n \"source_product_name\": \"\",\n \"group_id\": \"\",\n \"group_name\": \"\",\n \"description\": \"\",\n \"is_admin\": \"\",\n \"last_modified_on\": \"\",\n \"user_count\": \"\",\n \"external_account_id\": \"\",\n \"account_name\": \"\"\n },\n {\n \"ds_group_id\": \"\",\n \"account_id\": \"\",\n \"source_product_name\": \"\",\n \"group_id\": \"\",\n \"group_name\": \"\",\n \"description\": \"\",\n \"is_admin\": \"\",\n \"last_modified_on\": \"\",\n \"user_count\": \"\",\n \"external_account_id\": \"\",\n \"account_name\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } }, { - "_postman_id": "7249d416-aefc-42a3-ae87-f8b8a29b5fc0", - "name": "Add list of users to a DSGroup", + "id": "73e83ede-b896-444d-8e43-dadc4fc5a4b3", + "name": "Add a new DSGroup", "request": { + "name": "Creates a new DSGroup.", + "description": { + "content": "Required scopes: user_write", + "type": "text/markdown" + }, "url": { - "raw": "https://{{hostenv}}/Management/v2.1/organizations/{{organizationId}}/accounts/{{accountId}}/dsgroups/{{dsGroupId}}/users", - "protocol": "https", - "auth": {}, - "host": [ - "{{hostenv}}" - ], "path": [ - "Management", "v2.1", "organizations", - "{{organizationId}}", + ":organizationId", "accounts", - "{{accountId}}", - "dsgroups", - "{{dsGroupId}}", - "users" + ":accountId", + "dsgroups" + ], + "host": [ + "{{baseUrl}}" ], + "query": [], "variable": [ { - "value": "{{organizationId}}", - "id": "organizationId" + "type": "any", + "value": "", + "key": "organizationId", + "disabled": false, + "description": { + "content": "(Required) The organization ID GUID", + "type": "text/plain" + } }, { - "value": "{{accountId}}", - "id": "accountId" - }, - { - "value": "{{dsGroupId}}", - "id": "dsGroupId" + "type": "any", + "value": "", + "key": "accountId", + "disabled": false, + "description": { + "content": "(Required) The account ID GUID.", + "type": "text/plain" + } } ] }, - "method": "POST", "header": [ - { - "key": "Accept", - "value": "application/json", - "description": "" - }, { "key": "Content-Type", - "value": "application/json", - "description": "" + "value": "application/json" }, { - "key": "Authorization", - "value": "Bearer {{accessToken}}", - "description": "" + "key": "Accept", + "value": "application/json" } ], + "method": "POST", "body": { "mode": "raw", - "raw": "{}" + "raw": "{\n \"group_name\": \"\",\n \"description\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } }, - "description": "Required scopes: user_write" + "auth": null }, - "response": [] - }, - { - "_postman_id": "291bef47-e70f-49d3-9f46-659bb7d144bc", - "name": "Remove users from a DSGroup", - "request": { - "url": { - "raw": "https://{{hostenv}}/Management/v2.1/organizations/{{organizationId}}/accounts/{{accountId}}/dsgroups/{{dsGroupId}}/users", - "protocol": "https", - "auth": {}, - "host": [ - "{{hostenv}}" + "response": [ + { + "id": "681b86c0-ac62-4515-96ee-0c3a9a4f0f0c", + "name": "OK", + "originalRequest": { + "url": { + "path": [ + "v2.1", + "organizations", + ":organizationId", + "accounts", + ":accountId", + "dsgroups" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"group_name\": \"\",\n \"description\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "OK", + "code": 200, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } ], + "body": "{\n \"ds_group_id\": \"\",\n \"account_id\": \"\",\n \"source_product_name\": \"\",\n \"group_id\": \"\",\n \"group_name\": \"\",\n \"description\": \"\",\n \"is_admin\": \"\",\n \"last_modified_on\": \"\",\n \"user_count\": \"\",\n \"external_account_id\": \"\",\n \"account_name\": \"\"\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + }, + { + "id": "00be6c28-ce9f-4706-a034-fc4f65b29bd7", + "name": "Get list of DSGroup", + "request": { + "name": "Returns details about a single DSGroup.", + "description": { + "content": "Required scopes: user_read", + "type": "text/markdown" + }, + "url": { "path": [ - "Management", "v2.1", "organizations", - "{{organizationId}}", + ":organizationId", "accounts", - "{{accountId}}", + ":accountId", "dsgroups", - "{{dsGroupId}}", - "users" + ":dsGroupId" ], + "host": [ + "{{baseUrl}}" + ], + "query": [], "variable": [ { - "value": "{{organizationId}}", - "id": "organizationId" + "type": "any", + "value": "", + "key": "organizationId", + "disabled": false, + "description": { + "content": "(Required) The organization ID GUID", + "type": "text/plain" + } }, { - "value": "{{accountId}}", - "id": "accountId" + "type": "any", + "value": "", + "key": "accountId", + "disabled": false, + "description": { + "content": "(Required) The account ID GUID.", + "type": "text/plain" + } }, { - "value": "{{dsGroupId}}", - "id": "dsGroupId" + "type": "any", + "value": "", + "key": "dsGroupId", + "disabled": false, + "description": { + "content": "(Required) The DSGroup's ID GUID", + "type": "text/plain" + } } ] }, - "method": "DELETE", "header": [ { "key": "Accept", - "value": "application/json", - "description": "" - }, - { - "key": "Content-Type", - "value": "application/json", - "description": "" - }, - { - "key": "Authorization", - "value": "Bearer {{accessToken}}", - "description": "" + "value": "application/json" } ], - "body": { - "mode": "raw", - "raw": "{}" - }, - "description": "Required scopes: user_write" + "method": "GET", + "body": {}, + "auth": null }, - "response": [] + "response": [ + { + "id": "fd7f0980-2744-4bf7-bd7f-2c060535e99a", + "name": "OK", + "originalRequest": { + "url": { + "path": [ + "v2.1", + "organizations", + ":organizationId", + "accounts", + ":accountId", + "dsgroups", + ":dsGroupId" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "GET", + "body": {} + }, + "status": "OK", + "code": 200, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"ds_group_id\": \"\",\n \"account_id\": \"\",\n \"source_product_name\": \"\",\n \"group_id\": \"\",\n \"group_name\": \"\",\n \"description\": \"\",\n \"is_admin\": \"\",\n \"last_modified_on\": \"\",\n \"user_count\": \"\",\n \"external_account_id\": \"\",\n \"account_name\": \"\"\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } }, { - "_postman_id": "21670eeb-7e68-4e24-bf61-c94ee48af377", - "name": "Get products associated with the account and the available permission profiles", + "id": "ef9b82c0-a4ee-4917-8964-deb3152a6616", + "name": "Delete a DSGroup", "request": { + "name": "Deletes a DSGroup.", + "description": { + "content": "Required scopes: user_write", + "type": "text/markdown" + }, "url": { - "raw": "https://{{hostenv}}/Management/v2.1/organizations/{{organizationId}}/accounts/{{accountId}}/products/permission_profiles", - "protocol": "https", - "auth": {}, - "host": [ - "{{hostenv}}" - ], "path": [ - "Management", "v2.1", "organizations", - "{{organizationId}}", + ":organizationId", "accounts", - "{{accountId}}", - "products", - "permission_profiles" + ":accountId", + "dsgroups", + ":dsGroupId" + ], + "host": [ + "{{baseUrl}}" ], + "query": [], "variable": [ { - "value": "{{organizationId}}", - "id": "organizationId" + "type": "any", + "value": "", + "key": "organizationId", + "disabled": false, + "description": { + "content": "(Required) The organization ID GUID", + "type": "text/plain" + } + }, + { + "type": "any", + "value": "", + "key": "accountId", + "disabled": false, + "description": { + "content": "(Required) The account ID GUID.", + "type": "text/plain" + } }, { - "value": "{{accountId}}", - "id": "accountId" + "type": "any", + "value": "", + "key": "dsGroupId", + "disabled": false, + "description": { + "content": "(Required) The DSGroup's GUID.", + "type": "text/plain" + } } ] }, - "method": "GET", - "header": [ - { - "key": "Accept", - "value": "application/json", - "description": "" - }, - { - "key": "Content-Type", - "value": "application/json", - "description": "" - }, - { - "key": "Authorization", - "value": "Bearer {{accessToken}}", - "description": "" - } - ], - "body": { - "mode": "raw", - "raw": "{}" - }, - "description": "Required scopes: user_read" + "method": "DELETE", + "body": {}, + "auth": null }, - "response": [] + "response": [ + { + "id": "741bd60b-3d5c-436b-ade6-8a649edd0ce0", + "name": "No Content", + "originalRequest": { + "url": { + "path": [ + "v2.1", + "organizations", + ":organizationId", + "accounts", + ":accountId", + "dsgroups", + ":dsGroupId" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "method": "DELETE", + "body": {} + }, + "status": "No Content", + "code": 204, + "header": [], + "cookie": [], + "_postman_previewlanguage": "text" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } }, { - "_postman_id": "f145dcc1-361a-42c7-8b96-49007d0b7b27", - "name": "Retrieve list of user's permission profiles for each account's product", + "id": "fdff0094-197d-4cf0-82c0-f56561fad43a", + "name": "Get list of users in a DSGroup", "request": { + "name": "Gets a list of users in a DSGroup.", + "description": { + "content": "Required scopes: user_read", + "type": "text/markdown" + }, "url": { - "raw": "https://{{hostenv}}/Management/v2.1/organizations/{{organizationId}}/accounts/{{accountId}}/products/users/{{userId}}/permission_profiles", - "protocol": "https", - "auth": {}, - "host": [ - "{{hostenv}}" - ], "path": [ - "Management", "v2.1", "organizations", - "{{organizationId}}", + ":organizationId", "accounts", - "{{accountId}}", - "products", - "users", - "{{userId}}", - "permission_profiles" + ":accountId", + "dsgroups", + ":dsGroupId", + "users" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": true, + "description": { + "content": "Start page of DSGroups.\n", + "type": "text/plain" + }, + "key": "page", + "value": "" + }, + { + "disabled": true, + "description": { + "content": "Page size of DSGroups.", + "type": "text/plain" + }, + "key": "page_size", + "value": "" + } ], "variable": [ { - "value": "{{organizationId}}", - "id": "organizationId" + "type": "any", + "value": "", + "key": "organizationId", + "disabled": false, + "description": { + "content": "(Required) The organization ID GUID", + "type": "text/plain" + } }, { - "value": "{{accountId}}", - "id": "accountId" + "type": "any", + "value": "", + "key": "accountId", + "disabled": false, + "description": { + "content": "(Required) The account ID GUID.", + "type": "text/plain" + } }, { - "value": "{{userId}}", - "id": "userId" + "type": "any", + "value": "", + "key": "dsGroupId", + "disabled": false, + "description": { + "content": "(Required) The DSGroup's GUID.", + "type": "text/plain" + } } ] }, - "method": "GET", "header": [ { "key": "Accept", - "value": "application/json", - "description": "" - }, - { - "key": "Content-Type", - "value": "application/json", - "description": "" - }, - { - "key": "Authorization", - "value": "Bearer {{accessToken}}", - "description": "" + "value": "application/json" } ], - "body": { - "mode": "raw", - "raw": "{}" - }, - "description": "Required scopes: user_read" + "method": "GET", + "body": {}, + "auth": null }, - "response": [] + "response": [ + { + "id": "4202f85f-12dc-4d2f-8671-c5ef578bec13", + "name": "OK", + "originalRequest": { + "url": { + "path": [ + "v2.1", + "organizations", + ":organizationId", + "accounts", + ":accountId", + "dsgroups", + ":dsGroupId", + "users" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": true, + "description": { + "content": "Start page of DSGroups.\n", + "type": "text/plain" + }, + "key": "page", + "value": "" + }, + { + "disabled": true, + "description": { + "content": "Page size of DSGroups.", + "type": "text/plain" + }, + "key": "page_size", + "value": "" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "GET", + "body": {} + }, + "status": "OK", + "code": 200, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"group\": {\n \"ds_group_id\": \"\",\n \"account_id\": \"\",\n \"source_product_name\": \"\",\n \"group_id\": \"\",\n \"group_name\": \"\",\n \"description\": \"\",\n \"is_admin\": \"\",\n \"last_modified_on\": \"\",\n \"user_count\": \"\",\n \"external_account_id\": \"\",\n \"account_name\": \"\"\n },\n \"group_users\": {\n \"page\": \"\",\n \"page_size\": \"\",\n \"total_count\": \"\",\n \"users\": [\n {\n \"user_id\": \"\",\n \"account_id\": \"\",\n \"user_name\": \"\",\n \"first_name\": \"\",\n \"last_name\": \"\",\n \"middle_name\": \"\",\n \"status\": \"\",\n \"error_details\": {\n \"error\": \"\",\n \"error_description\": \"\"\n }\n },\n {\n \"user_id\": \"\",\n \"account_id\": \"\",\n \"user_name\": \"\",\n \"first_name\": \"\",\n \"last_name\": \"\",\n \"middle_name\": \"\",\n \"status\": \"\",\n \"error_details\": {\n \"error\": \"\",\n \"error_description\": \"\"\n }\n }\n ]\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } }, { - "_postman_id": "966045bc-05ca-4015-b9f5-61d81b65a501", - "name": "Assign user to permission profiles for one or more products", + "id": "7249d416-aefc-42a3-ae87-f8b8a29b5fc0", + "name": "Add list of users to a DSGroup", "request": { + "name": "Adds a list of users to a DSGroup.", + "description": { + "content": "Required scopes: user_write", + "type": "text/markdown" + }, "url": { - "raw": "https://{{hostenv}}/Management/v2.1/organizations/{{organizationId}}/accounts/{{accountId}}/products/users/{{userId}}/permission_profiles", - "protocol": "https", - "auth": {}, - "host": [ - "{{hostenv}}" - ], "path": [ - "Management", "v2.1", "organizations", - "{{organizationId}}", + ":organizationId", "accounts", - "{{accountId}}", - "products", - "users", - "{{userId}}", - "permission_profiles" + ":accountId", + "dsgroups", + ":dsGroupId", + "users" + ], + "host": [ + "{{baseUrl}}" ], + "query": [], "variable": [ { - "value": "{{organizationId}}", - "id": "organizationId" + "type": "any", + "value": "", + "key": "organizationId", + "disabled": false, + "description": { + "content": "(Required) The organization ID GUID", + "type": "text/plain" + } }, { - "value": "{{accountId}}", - "id": "accountId" + "type": "any", + "value": "", + "key": "accountId", + "disabled": false, + "description": { + "content": "(Required) The account ID GUID.", + "type": "text/plain" + } }, { - "value": "{{userId}}", - "id": "userId" + "type": "any", + "value": "", + "key": "dsGroupId", + "disabled": false, + "description": { + "content": "(Required) The DSGroup's GUID.", + "type": "text/plain" + } } ] }, - "method": "POST", "header": [ - { - "key": "Accept", - "value": "application/json", - "description": "" - }, { "key": "Content-Type", - "value": "application/json", - "description": "" + "value": "application/json" }, { - "key": "Authorization", - "value": "Bearer {{accessToken}}", - "description": "" + "key": "Accept", + "value": "application/json" } ], + "method": "POST", "body": { "mode": "raw", - "raw": "{}" + "raw": "{\n \"user_ids\": [\n \"\",\n \"\"\n ]\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } }, - "description": "Required scopes: user_write" + "auth": null }, - "response": [] + "response": [ + { + "id": "24f0ba5b-34eb-4ac9-878e-e04715c2338c", + "name": "OK", + "originalRequest": { + "url": { + "path": [ + "v2.1", + "organizations", + ":organizationId", + "accounts", + ":accountId", + "dsgroups", + ":dsGroupId", + "users" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"user_ids\": [\n \"\",\n \"\"\n ]\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "OK", + "code": 200, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"group\": {\n \"ds_group_id\": \"\",\n \"account_id\": \"\",\n \"source_product_name\": \"\",\n \"group_id\": \"\",\n \"group_name\": \"\",\n \"description\": \"\",\n \"is_admin\": \"\",\n \"last_modified_on\": \"\",\n \"user_count\": \"\",\n \"external_account_id\": \"\",\n \"account_name\": \"\"\n },\n \"group_users\": {\n \"is_success\": \"\",\n \"TotalCount\": \"\",\n \"users\": [\n {\n \"user_id\": \"\",\n \"account_id\": \"\",\n \"user_name\": \"\",\n \"first_name\": \"\",\n \"last_name\": \"\",\n \"middle_name\": \"\",\n \"status\": \"\",\n \"error_details\": {\n \"error\": \"\",\n \"error_description\": \"\"\n }\n },\n {\n \"user_id\": \"\",\n \"account_id\": \"\",\n \"user_name\": \"\",\n \"first_name\": \"\",\n \"last_name\": \"\",\n \"middle_name\": \"\",\n \"status\": \"\",\n \"error_details\": {\n \"error\": \"\",\n \"error_description\": \"\"\n }\n }\n ]\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } }, { - "_postman_id": "6a04a8df-91a4-4c6f-82d6-fc12b4d3e5c8", - "name": "Creates and updates a multi-product user", + "id": "291bef47-e70f-49d3-9f46-659bb7d144bc", + "name": "Remove users from a DSGroup", "request": { + "name": "Removes a list of users from a DSGroup.", + "description": { + "content": "Required scopes: user_write", + "type": "text/markdown" + }, "url": { - "raw": "https://{{hostenv}}/Management/v2.1/organizations/{{organizationId}}/accounts/{{accountId}}/users", - "protocol": "https", - "auth": {}, - "host": [ - "{{hostenv}}" - ], "path": [ - "Management", "v2.1", "organizations", - "{{organizationId}}", + ":organizationId", "accounts", - "{{accountId}}", + ":accountId", + "dsgroups", + ":dsGroupId", "users" ], + "host": [ + "{{baseUrl}}" + ], + "query": [], "variable": [ { - "value": "{{organizationId}}", - "id": "organizationId" + "type": "any", + "value": "", + "key": "organizationId", + "disabled": false, + "description": { + "content": "(Required) The organization ID GUID", + "type": "text/plain" + } + }, + { + "type": "any", + "value": "", + "key": "accountId", + "disabled": false, + "description": { + "content": "(Required) The account ID GUID.", + "type": "text/plain" + } }, { - "value": "{{accountId}}", - "id": "accountId" + "type": "any", + "value": "", + "key": "dsGroupId", + "disabled": false, + "description": { + "content": "(Required) The DSGroup's GUID.", + "type": "text/plain" + } } ] }, - "method": "POST", "header": [ - { - "key": "Accept", - "value": "application/json", - "description": "" - }, { "key": "Content-Type", - "value": "application/json", - "description": "" + "value": "application/json" }, { - "key": "Authorization", - "value": "Bearer {{accessToken}}", - "description": "" + "key": "Accept", + "value": "application/json" } ], + "method": "DELETE", "body": { "mode": "raw", - "raw": "{}" + "raw": "{\n \"user_ids\": [\n \"\",\n \"\"\n ],\n \"user_emails\": [\n \"\",\n \"\"\n ]\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } }, - "description": "Required scopes: user_write" + "auth": null }, - "response": [] + "response": [ + { + "id": "2a9c0bd4-b9d3-4916-bbfe-b6bb584f5efa", + "name": "OK", + "originalRequest": { + "url": { + "path": [ + "v2.1", + "organizations", + ":organizationId", + "accounts", + ":accountId", + "dsgroups", + ":dsGroupId", + "users" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "DELETE", + "body": { + "mode": "raw", + "raw": "{\n \"user_ids\": [\n \"\",\n \"\"\n ],\n \"user_emails\": [\n \"\",\n \"\"\n ]\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "OK", + "code": 200, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"is_success\": \"\",\n \"failed_users\": [\n {\n \"user_id\": \"\",\n \"account_id\": \"\",\n \"user_name\": \"\",\n \"first_name\": \"\",\n \"last_name\": \"\",\n \"middle_name\": \"\",\n \"status\": \"\",\n \"error_details\": {\n \"error\": \"\",\n \"error_description\": \"\"\n }\n },\n {\n \"user_id\": \"\",\n \"account_id\": \"\",\n \"user_name\": \"\",\n \"first_name\": \"\",\n \"last_name\": \"\",\n \"middle_name\": \"\",\n \"status\": \"\",\n \"error_details\": {\n \"error\": \"\",\n \"error_description\": \"\"\n }\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } }, { - "_postman_id": "5af9dd1a-a22c-44b0-8b6c-dce46f09822d", - "name": "Returns DS user profile information.", + "id": "21670eeb-7e68-4e24-bf61-c94ee48af377", + "name": "Get products associated with the account and the available permission profiles", "request": { + "name": "Gets products associated with the account and the available permission profiles.", + "description": { + "content": "Required scopes: user_read", + "type": "text/markdown" + }, "url": { - "raw": "https://{{hostenv}}/Management/v2.1/organizations/{{organizationId}}/users/dsprofile?email={{email}}&sort={{sort}}", - "protocol": "https", - "auth": {}, - "host": [ - "{{hostenv}}" - ], "path": [ - "Management", "v2.1", "organizations", - "{{organizationId}}", - "users", - "dsprofile" + ":organizationId", + "accounts", + ":accountId", + "products", + "permission_profiles" ], - "query": [ - { - "key": "email", - "value": "{{email}}" - }, - { - "key": "sort", - "value": "{{sort}}" - } + "host": [ + "{{baseUrl}}" ], + "query": [], "variable": [ { - "value": "{{organizationId}}", - "id": "organizationId" + "type": "any", + "value": "", + "key": "organizationId", + "disabled": false, + "description": { + "content": "(Required) The organization ID GUID", + "type": "text/plain" + } + }, + { + "type": "any", + "value": "", + "key": "accountId", + "disabled": false, + "description": { + "content": "(Required) The account ID GUID.", + "type": "text/plain" + } } ] }, - "method": "GET", "header": [ { "key": "Accept", - "value": "application/json", - "description": "" - }, - { - "key": "Content-Type", - "value": "application/json", - "description": "" - }, - { - "key": "Authorization", - "value": "Bearer {{accessToken}}", - "description": "" + "value": "application/json" } ], - "body": { - "mode": "raw", - "raw": "{}" - }, - "description": "Required scopes: user_read" + "method": "GET", + "body": {}, + "auth": null }, - "response": [] + "response": [ + { + "id": "58e8a5d7-bdb9-4daf-8444-1896523aae7e", + "name": "OK", + "originalRequest": { + "url": { + "path": [ + "v2.1", + "organizations", + ":organizationId", + "accounts", + ":accountId", + "products", + "permission_profiles" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "GET", + "body": {} + }, + "status": "OK", + "code": 200, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"product_permission_profiles\": [\n {\n \"product_id\": \"\",\n \"product_name\": \"\",\n \"permission_profiles\": [\n {\n \"permission_profile_id\": \"\",\n \"permission_profile_name\": \"\"\n },\n {\n \"permission_profile_id\": \"\",\n \"permission_profile_name\": \"\"\n }\n ],\n \"error_message\": \"\"\n },\n {\n \"product_id\": \"\",\n \"product_name\": \"\",\n \"permission_profiles\": [\n {\n \"permission_profile_id\": \"\",\n \"permission_profile_name\": \"\"\n },\n {\n \"permission_profile_id\": \"\",\n \"permission_profile_name\": \"\"\n }\n ],\n \"error_message\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } }, { - "_postman_id": "a08e20fc-fdc6-4d39-9247-12da03a78853", - "name": "Returns user information using the userId for lookup.", + "id": "f145dcc1-361a-42c7-8b96-49007d0b7b27", + "name": "Retrieve list of user's permission profiles for each account's product", "request": { + "name": "Retrieves a user's product permission profiles by user ID.", + "description": { + "content": "Required scopes: user_read", + "type": "text/markdown" + }, "url": { - "raw": "https://{{hostenv}}/Management/v2.1/organizations/{{organizationId}}/users/{{userId}}/dsprofile?sort={{sort}}", - "protocol": "https", - "auth": {}, - "host": [ - "{{hostenv}}" - ], "path": [ - "Management", "v2.1", "organizations", - "{{organizationId}}", + ":organizationId", + "accounts", + ":accountId", + "products", "users", - "{{userId}}", - "dsprofile" + ":userId", + "permission_profiles" ], - "query": [ - { - "key": "sort", - "value": "{{sort}}" - } + "host": [ + "{{baseUrl}}" ], + "query": [], "variable": [ { - "value": "{{organizationId}}", - "id": "organizationId" + "type": "any", + "value": "", + "key": "organizationId", + "disabled": false, + "description": { + "content": "(Required) The organization ID GUID", + "type": "text/plain" + } }, { - "value": "{{userId}}", - "id": "userId" + "type": "any", + "value": "", + "key": "accountId", + "disabled": false, + "description": { + "content": "(Required) The account ID GUID.", + "type": "text/plain" + } + }, + { + "type": "any", + "value": "", + "key": "userId", + "disabled": false, + "description": { + "content": "(Required) The user ID GUID.", + "type": "text/plain" + } } ] }, - "method": "GET", "header": [ { "key": "Accept", - "value": "application/json", - "description": "" - }, - { - "key": "Content-Type", - "value": "application/json", - "description": "" - }, - { - "key": "Authorization", - "value": "Bearer {{accessToken}}", - "description": "" + "value": "application/json" } ], - "body": { - "mode": "raw", - "raw": "{}" - }, - "description": "Required scopes: user_read" + "method": "GET", + "body": {}, + "auth": null }, - "response": [] + "response": [ + { + "id": "02c00bf7-9c5d-47fd-b7ce-0d4bd727ee85", + "name": "OK", + "originalRequest": { + "url": { + "path": [ + "v2.1", + "organizations", + ":organizationId", + "accounts", + ":accountId", + "products", + "users", + ":userId", + "permission_profiles" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "GET", + "body": {} + }, + "status": "OK", + "code": 200, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"product_permission_profiles\": [\n {\n \"product_id\": \"\",\n \"product_name\": \"\",\n \"permission_profiles\": [\n {\n \"permission_profile_id\": \"\",\n \"permission_profile_name\": \"\"\n },\n {\n \"permission_profile_id\": \"\",\n \"permission_profile_name\": \"\"\n }\n ],\n \"error_message\": \"\"\n },\n {\n \"product_id\": \"\",\n \"product_name\": \"\",\n \"permission_profiles\": [\n {\n \"permission_profile_id\": \"\",\n \"permission_profile_name\": \"\"\n },\n {\n \"permission_profile_id\": \"\",\n \"permission_profile_name\": \"\"\n }\n ],\n \"error_message\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } }, { - "_postman_id": "8568c150-175a-4762-98b7-8cbdabb46edf", - "name": "Remove user from permission profiles for one or more products", + "id": "966045bc-05ca-4015-b9f5-61d81b65a501", + "name": "Assign user to permission profiles for one or more products", "request": { + "name": "Assigns permission profiles for a user by user ID.", + "description": { + "content": "Required scopes: user_write", + "type": "text/markdown" + }, "url": { - "raw": "https://{{hostenv}}/Management/v2.1/organizations/{{organizationId}}/accounts/{{accountId}}/products/users", - "protocol": "https", - "auth": {}, - "host": [ - "{{hostenv}}" - ], "path": [ - "Management", "v2.1", "organizations", - "{{organizationId}}", + ":organizationId", "accounts", - "{{accountId}}", + ":accountId", "products", - "users" + "users", + ":userId", + "permission_profiles" + ], + "host": [ + "{{baseUrl}}" ], + "query": [], "variable": [ { - "value": "{{organizationId}}", - "id": "organizationId" + "type": "any", + "value": "", + "key": "organizationId", + "disabled": false, + "description": { + "content": "(Required) The organization ID GUID", + "type": "text/plain" + } + }, + { + "type": "any", + "value": "", + "key": "accountId", + "disabled": false, + "description": { + "content": "(Required) The account ID GUID.", + "type": "text/plain" + } }, { - "value": "{{accountId}}", - "id": "accountId" + "type": "any", + "value": "", + "key": "userId", + "disabled": false, + "description": { + "content": "(Required) The user ID GUID.", + "type": "text/plain" + } } ] }, - "method": "DELETE", "header": [ { - "key": "Accept", - "value": "application/json", - "description": "" + "key": "Content-Type", + "value": "application/json" }, { - "key": "Content-Type", - "value": "application/json", - "description": "" - }, - { - "key": "Authorization", - "value": "Bearer {{accessToken}}", - "description": "" + "key": "Accept", + "value": "application/json" } ], + "method": "POST", "body": { "mode": "raw", - "raw": "{}" + "raw": "{\n \"product_permission_profiles\": [\n {\n \"product_id\": \"\",\n \"permission_profile_id\": \"\"\n },\n {\n \"product_id\": \"\",\n \"permission_profile_id\": \"\"\n }\n ]\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } }, - "description": "Required scopes: user_write" + "auth": null }, - "response": [] + "response": [ + { + "id": "833acc9f-383f-42a2-888f-9400f0754b77", + "name": "OK", + "originalRequest": { + "url": { + "path": [ + "v2.1", + "organizations", + ":organizationId", + "accounts", + ":accountId", + "products", + "users", + ":userId", + "permission_profiles" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"product_permission_profiles\": [\n {\n \"product_id\": \"\",\n \"permission_profile_id\": \"\"\n },\n {\n \"product_id\": \"\",\n \"permission_profile_id\": \"\"\n }\n ]\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "OK", + "code": 200, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"user_id\": \"\",\n \"account_id\": \"\",\n \"product_permission_profiles\": [\n {\n \"product_id\": \"\",\n \"product_name\": \"\",\n \"permission_profiles\": [\n {\n \"permission_profile_id\": \"\",\n \"permission_profile_name\": \"\"\n },\n {\n \"permission_profile_id\": \"\",\n \"permission_profile_name\": \"\"\n }\n ],\n \"error_message\": \"\"\n },\n {\n \"product_id\": \"\",\n \"product_name\": \"\",\n \"permission_profiles\": [\n {\n \"permission_profile_id\": \"\",\n \"permission_profile_name\": \"\"\n },\n {\n \"permission_profile_id\": \"\",\n \"permission_profile_name\": \"\"\n }\n ],\n \"error_message\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } }, { - "_postman_id": "bfc965b2-3cc5-4bbc-a689-68bad7f0a42a", - "name": "Remove user from permission profiles for one or more products", + "id": "6a04a8df-91a4-4c6f-82d6-fc12b4d3e5c8", + "name": "Creates and updates a multi-product user", "request": { + "name": "Creates or updates a multi-product user.", + "description": { + "content": "Required scopes: user_write", + "type": "text/markdown" + }, "url": { - "raw": "https://{{hostenv}}/Management/v2.1/organizations/{{organizationId}}/accounts/{{accountId}}/products/permission_profiles/users?email={{email}}", - "protocol": "https", - "auth": {}, - "host": [ - "{{hostenv}}" - ], "path": [ - "Management", "v2.1", "organizations", - "{{organizationId}}", + ":organizationId", "accounts", - "{{accountId}}", - "products", - "permission_profiles", + ":accountId", "users" ], - "query": [ - { - "key": "email", - "value": "{{email}}" - } + "host": [ + "{{baseUrl}}" ], + "query": [], "variable": [ { - "value": "{{organizationId}}", - "id": "organizationId" + "type": "any", + "value": "", + "key": "organizationId", + "disabled": false, + "description": { + "content": "(Required) The organization ID.", + "type": "text/plain" + } }, { - "value": "{{accountId}}", - "id": "accountId" + "type": "any", + "value": "", + "key": "accountId", + "disabled": false, + "description": { + "content": "(Required) The account ID GUID.", + "type": "text/plain" + } } ] }, - "method": "GET", "header": [ - { - "key": "Accept", - "value": "application/json", - "description": "" - }, { "key": "Content-Type", - "value": "application/json", - "description": "" + "value": "application/json" }, { - "key": "Authorization", - "value": "Bearer {{accessToken}}", - "description": "" + "key": "Accept", + "value": "application/json" } ], + "method": "POST", "body": { "mode": "raw", - "raw": "{}" + "raw": "{\n \"product_permission_profiles\": [\n {\n \"product_id\": \"\",\n \"permission_profile_id\": \"\"\n },\n {\n \"product_id\": \"\",\n \"permission_profile_id\": \"\"\n }\n ],\n \"email\": \"\",\n \"ds_groups\": [\n {\n \"ds_group_id\": \"\"\n },\n {\n \"ds_group_id\": \"\"\n }\n ],\n \"user_name\": \"\",\n \"first_name\": \"\",\n \"last_name\": \"\",\n \"default_account_id\": \"\",\n \"language_culture\": \"\",\n \"access_code\": \"\",\n \"federated_status\": \"\",\n \"auto_activate_memberships\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } }, - "description": "Required scopes: user_write" + "auth": null }, - "response": [] + "response": [ + { + "id": "dfc8d219-38d6-4bb3-9b08-4eb9d8160d6e", + "name": "OK", + "originalRequest": { + "url": { + "path": [ + "v2.1", + "organizations", + ":organizationId", + "accounts", + ":accountId", + "users" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"product_permission_profiles\": [\n {\n \"product_id\": \"\",\n \"permission_profile_id\": \"\"\n },\n {\n \"product_id\": \"\",\n \"permission_profile_id\": \"\"\n }\n ],\n \"email\": \"\",\n \"ds_groups\": [\n {\n \"ds_group_id\": \"\"\n },\n {\n \"ds_group_id\": \"\"\n }\n ],\n \"user_name\": \"\",\n \"first_name\": \"\",\n \"last_name\": \"\",\n \"default_account_id\": \"\",\n \"language_culture\": \"\",\n \"access_code\": \"\",\n \"federated_status\": \"\",\n \"auto_activate_memberships\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "OK", + "code": 200, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"id\": \"\",\n \"site_id\": \"\",\n \"user_name\": \"\",\n \"first_name\": \"\",\n \"last_name\": \"\",\n \"email\": \"\",\n \"language_culture\": \"\",\n \"federated_status\": \"\",\n \"accounts\": [\n {\n \"id\": \"\",\n \"site_id\": \"\",\n \"product_permission_profiles\": [\n {\n \"product_id\": \"\",\n \"product_name\": \"\",\n \"permission_profiles\": [\n {\n \"permission_profile_id\": \"\",\n \"permission_profile_name\": \"\"\n },\n {\n \"permission_profile_id\": \"\",\n \"permission_profile_name\": \"\"\n }\n ],\n \"error_message\": \"\"\n },\n {\n \"product_id\": \"\",\n \"product_name\": \"\",\n \"permission_profiles\": [\n {\n \"permission_profile_id\": \"\",\n \"permission_profile_name\": \"\"\n },\n {\n \"permission_profile_id\": \"\",\n \"permission_profile_name\": \"\"\n }\n ],\n \"error_message\": \"\"\n }\n ],\n \"ds_groups\": [\n {\n \"ds_group_id\": \"\",\n \"account_id\": \"\",\n \"source_product_name\": \"\",\n \"group_id\": \"\",\n \"group_name\": \"\",\n \"description\": \"\",\n \"is_admin\": \"\",\n \"last_modified_on\": \"\",\n \"user_count\": \"\",\n \"external_account_id\": \"\",\n \"account_name\": \"\"\n },\n {\n \"ds_group_id\": \"\",\n \"account_id\": \"\",\n \"source_product_name\": \"\",\n \"group_id\": \"\",\n \"group_name\": \"\",\n \"description\": \"\",\n \"is_admin\": \"\",\n \"last_modified_on\": \"\",\n \"user_count\": \"\",\n \"external_account_id\": \"\",\n \"account_name\": \"\"\n }\n ],\n \"company_name\": \"\",\n \"job_title\": \"\"\n },\n {\n \"id\": \"\",\n \"site_id\": \"\",\n \"product_permission_profiles\": [\n {\n \"product_id\": \"\",\n \"product_name\": \"\",\n \"permission_profiles\": [\n {\n \"permission_profile_id\": \"\",\n \"permission_profile_name\": \"\"\n },\n {\n \"permission_profile_id\": \"\",\n \"permission_profile_name\": \"\"\n }\n ],\n \"error_message\": \"\"\n },\n {\n \"product_id\": \"\",\n \"product_name\": \"\",\n \"permission_profiles\": [\n {\n \"permission_profile_id\": \"\",\n \"permission_profile_name\": \"\"\n },\n {\n \"permission_profile_id\": \"\",\n \"permission_profile_name\": \"\"\n }\n ],\n \"error_message\": \"\"\n }\n ],\n \"ds_groups\": [\n {\n \"ds_group_id\": \"\",\n \"account_id\": \"\",\n \"source_product_name\": \"\",\n \"group_id\": \"\",\n \"group_name\": \"\",\n \"description\": \"\",\n \"is_admin\": \"\",\n \"last_modified_on\": \"\",\n \"user_count\": \"\",\n \"external_account_id\": \"\",\n \"account_name\": \"\"\n },\n {\n \"ds_group_id\": \"\",\n \"account_id\": \"\",\n \"source_product_name\": \"\",\n \"group_id\": \"\",\n \"group_name\": \"\",\n \"description\": \"\",\n \"is_admin\": \"\",\n \"last_modified_on\": \"\",\n \"user_count\": \"\",\n \"external_account_id\": \"\",\n \"account_name\": \"\"\n }\n ],\n \"company_name\": \"\",\n \"job_title\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } }, { - "_postman_id": "e50af85a-6a84-4481-81ac-7a8c48986c27", - "name": "Assign user to permission profiles for one or more products", + "id": "5af9dd1a-a22c-44b0-8b6c-dce46f09822d", + "name": "Returns DS user profile information.", "request": { + "name": "Retrieves the DS profile for a user specified by email address.", + "description": { + "content": "Required scopes: user_read", + "type": "text/markdown" + }, "url": { - "raw": "https://{{hostenv}}/Management/v2.1/organizations/{{organizationId}}/accounts/{{accountId}}/products/permission_profiles/users", - "protocol": "https", - "auth": {}, - "host": [ - "{{hostenv}}" - ], "path": [ - "Management", "v2.1", "organizations", - "{{organizationId}}", - "accounts", - "{{accountId}}", - "products", - "permission_profiles", - "users" + ":organizationId", + "users", + "dsprofile" ], - "variable": [ + "host": [ + "{{baseUrl}}" + ], + "query": [ { - "value": "{{organizationId}}", - "id": "organizationId" + "disabled": true, + "description": { + "content": "The email address of the user.\n\n**Note:** This property is required.", + "type": "text/plain" + }, + "key": "email", + "value": "" }, { - "value": "{{accountId}}", - "id": "accountId" + "disabled": true, + "description": { + "content": "When **true,** sorts the results in ascending order by account name.", + "type": "text/plain" + }, + "key": "sort", + "value": "" + } + ], + "variable": [ + { + "type": "any", + "value": "", + "key": "organizationId", + "disabled": false, + "description": { + "content": "(Required) The organization's GUID.\n", + "type": "text/plain" + } } ] }, - "method": "POST", "header": [ { "key": "Accept", - "value": "application/json", - "description": "" - }, - { - "key": "Content-Type", - "value": "application/json", - "description": "" - }, - { - "key": "Authorization", - "value": "Bearer {{accessToken}}", - "description": "" + "value": "application/json" } ], - "body": { - "mode": "raw", - "raw": "{}" - }, - "description": "Required scopes: user_write" + "method": "GET", + "body": {}, + "auth": null }, - "response": [] - } - ] - }, - { - "_postman_id": "ac2a84f2-b729-4d28-87df-26738d9e2c44", - "name": "BulkOperations", - "description": "Folder for BulkOperations", - "item": [ + "response": [ + { + "id": "1a6e6340-ba14-4a34-85df-de67b3a9d8f9", + "name": "OK", + "originalRequest": { + "url": { + "path": [ + "v2.1", + "organizations", + ":organizationId", + "users", + "dsprofile" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": true, + "description": { + "content": "The email address of the user.\n\n**Note:** This property is required.", + "type": "text/plain" + }, + "key": "email", + "value": "" + }, + { + "disabled": true, + "description": { + "content": "When **true,** sorts the results in ascending order by account name.", + "type": "text/plain" + }, + "key": "sort", + "value": "" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "GET", + "body": {} + }, + "status": "OK", + "code": 200, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"users\": [\n {\n \"id\": \"\",\n \"site_id\": \"\",\n \"site_name\": \"\",\n \"user_name\": \"\",\n \"first_name\": \"\",\n \"last_name\": \"\",\n \"user_status\": \"\",\n \"default_account_id\": \"\",\n \"default_account_name\": \"\",\n \"language_culture\": \"\",\n \"selected_languages\": \"\",\n \"federated_status\": \"\",\n \"is_organization_admin\": \"\",\n \"created_on\": \"\",\n \"last_login\": \"\",\n \"memberships\": [\n {\n \"email\": \"\",\n \"account_id\": \"\",\n \"external_account_id\": \"\",\n \"account_name\": \"\",\n \"is_external_account\": \"\",\n \"status\": \"\",\n \"permission_profile\": {\n \"id\": \"\",\n \"name\": \"\"\n },\n \"created_on\": \"\",\n \"groups\": [\n {\n \"id\": \"\",\n \"name\": \"\",\n \"type\": \"\"\n },\n {\n \"id\": \"\",\n \"name\": \"\",\n \"type\": \"\"\n }\n ],\n \"is_admin\": \"\"\n },\n {\n \"email\": \"\",\n \"account_id\": \"\",\n \"external_account_id\": \"\",\n \"account_name\": \"\",\n \"is_external_account\": \"\",\n \"status\": \"\",\n \"permission_profile\": {\n \"id\": \"\",\n \"name\": \"\"\n },\n \"created_on\": \"\",\n \"groups\": [\n {\n \"id\": \"\",\n \"name\": \"\",\n \"type\": \"\"\n },\n {\n \"id\": \"\",\n \"name\": \"\",\n \"type\": \"\"\n }\n ],\n \"is_admin\": \"\"\n }\n ],\n \"identities\": [\n {\n \"id\": \"\",\n \"provider_id\": \"\",\n \"user_id\": \"\",\n \"immutable_id\": \"\",\n \"error_details\": {\n \"error\": \"\",\n \"error_description\": \"\"\n }\n },\n {\n \"id\": \"\",\n \"provider_id\": \"\",\n \"user_id\": \"\",\n \"immutable_id\": \"\",\n \"error_details\": {\n \"error\": \"\",\n \"error_description\": \"\"\n }\n }\n ],\n \"device_verification_enabled\": \"\"\n },\n {\n \"id\": \"\",\n \"site_id\": \"\",\n \"site_name\": \"\",\n \"user_name\": \"\",\n \"first_name\": \"\",\n \"last_name\": \"\",\n \"user_status\": \"\",\n \"default_account_id\": \"\",\n \"default_account_name\": \"\",\n \"language_culture\": \"\",\n \"selected_languages\": \"\",\n \"federated_status\": \"\",\n \"is_organization_admin\": \"\",\n \"created_on\": \"\",\n \"last_login\": \"\",\n \"memberships\": [\n {\n \"email\": \"\",\n \"account_id\": \"\",\n \"external_account_id\": \"\",\n \"account_name\": \"\",\n \"is_external_account\": \"\",\n \"status\": \"\",\n \"permission_profile\": {\n \"id\": \"\",\n \"name\": \"\"\n },\n \"created_on\": \"\",\n \"groups\": [\n {\n \"id\": \"\",\n \"name\": \"\",\n \"type\": \"\"\n },\n {\n \"id\": \"\",\n \"name\": \"\",\n \"type\": \"\"\n }\n ],\n \"is_admin\": \"\"\n },\n {\n \"email\": \"\",\n \"account_id\": \"\",\n \"external_account_id\": \"\",\n \"account_name\": \"\",\n \"is_external_account\": \"\",\n \"status\": \"\",\n \"permission_profile\": {\n \"id\": \"\",\n \"name\": \"\"\n },\n \"created_on\": \"\",\n \"groups\": [\n {\n \"id\": \"\",\n \"name\": \"\",\n \"type\": \"\"\n },\n {\n \"id\": \"\",\n \"name\": \"\",\n \"type\": \"\"\n }\n ],\n \"is_admin\": \"\"\n }\n ],\n \"identities\": [\n {\n \"id\": \"\",\n \"provider_id\": \"\",\n \"user_id\": \"\",\n \"immutable_id\": \"\",\n \"error_details\": {\n \"error\": \"\",\n \"error_description\": \"\"\n }\n },\n {\n \"id\": \"\",\n \"provider_id\": \"\",\n \"user_id\": \"\",\n \"immutable_id\": \"\",\n \"error_details\": {\n \"error\": \"\",\n \"error_description\": \"\"\n }\n }\n ],\n \"device_verification_enabled\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + }, { - "_postman_id": "d5b71573-6b77-46fd-b796-63c107d3caf3", - "name": "Returns a list of existing User List Exports (requests and completed exports) and their details/metadata", + "id": "a08e20fc-fdc6-4d39-9247-12da03a78853", + "name": "Returns user information using the userId for lookup.", "request": { + "name": "Retrieves the DS profile for a user specified by ID.", + "description": { + "content": "Required scopes: user_read", + "type": "text/markdown" + }, "url": { - "raw": "https://{{hostenv}}/Management/v2/organizations/{{organizationId}}/exports/user_list", - "protocol": "https", - "auth": {}, - "host": [ - "{{hostenv}}" - ], "path": [ - "Management", - "v2", + "v2.1", "organizations", - "{{organizationId}}", - "exports", - "user_list" + ":organizationId", + "users", + ":userId", + "dsprofile" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": true, + "description": { + "content": "When **true,** sorts the results in ascending order by account name.", + "type": "text/plain" + }, + "key": "sort", + "value": "" + } ], "variable": [ { - "value": "{{organizationId}}", - "id": "organizationId" + "type": "any", + "value": "", + "key": "organizationId", + "disabled": false, + "description": { + "content": "(Required) The organization's GUID.\n", + "type": "text/plain" + } + }, + { + "type": "any", + "value": "", + "key": "userId", + "disabled": false, + "description": { + "content": "(Required) The user ID GUID.", + "type": "text/plain" + } } ] }, - "method": "GET", "header": [ { "key": "Accept", - "value": "application/json", - "description": "" - }, - { - "key": "Content-Type", - "value": "application/json", - "description": "" - }, - { - "key": "Authorization", - "value": "Bearer {{accessToken}}", - "description": "" + "value": "application/json" } ], - "body": { - "mode": "raw", - "raw": "{}" - }, - "description": "Required scopes: user_read" + "method": "GET", + "body": {}, + "auth": null }, - "response": [] + "response": [ + { + "id": "d0f9cd04-15ca-489c-abf8-c77e3ccbac9b", + "name": "OK", + "originalRequest": { + "url": { + "path": [ + "v2.1", + "organizations", + ":organizationId", + "users", + ":userId", + "dsprofile" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": true, + "description": { + "content": "When **true,** sorts the results in ascending order by account name.", + "type": "text/plain" + }, + "key": "sort", + "value": "" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "GET", + "body": {} + }, + "status": "OK", + "code": 200, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"users\": [\n {\n \"id\": \"\",\n \"site_id\": \"\",\n \"site_name\": \"\",\n \"user_name\": \"\",\n \"first_name\": \"\",\n \"last_name\": \"\",\n \"user_status\": \"\",\n \"default_account_id\": \"\",\n \"default_account_name\": \"\",\n \"language_culture\": \"\",\n \"selected_languages\": \"\",\n \"federated_status\": \"\",\n \"is_organization_admin\": \"\",\n \"created_on\": \"\",\n \"last_login\": \"\",\n \"memberships\": [\n {\n \"email\": \"\",\n \"account_id\": \"\",\n \"external_account_id\": \"\",\n \"account_name\": \"\",\n \"is_external_account\": \"\",\n \"status\": \"\",\n \"permission_profile\": {\n \"id\": \"\",\n \"name\": \"\"\n },\n \"created_on\": \"\",\n \"groups\": [\n {\n \"id\": \"\",\n \"name\": \"\",\n \"type\": \"\"\n },\n {\n \"id\": \"\",\n \"name\": \"\",\n \"type\": \"\"\n }\n ],\n \"is_admin\": \"\"\n },\n {\n \"email\": \"\",\n \"account_id\": \"\",\n \"external_account_id\": \"\",\n \"account_name\": \"\",\n \"is_external_account\": \"\",\n \"status\": \"\",\n \"permission_profile\": {\n \"id\": \"\",\n \"name\": \"\"\n },\n \"created_on\": \"\",\n \"groups\": [\n {\n \"id\": \"\",\n \"name\": \"\",\n \"type\": \"\"\n },\n {\n \"id\": \"\",\n \"name\": \"\",\n \"type\": \"\"\n }\n ],\n \"is_admin\": \"\"\n }\n ],\n \"identities\": [\n {\n \"id\": \"\",\n \"provider_id\": \"\",\n \"user_id\": \"\",\n \"immutable_id\": \"\",\n \"error_details\": {\n \"error\": \"\",\n \"error_description\": \"\"\n }\n },\n {\n \"id\": \"\",\n \"provider_id\": \"\",\n \"user_id\": \"\",\n \"immutable_id\": \"\",\n \"error_details\": {\n \"error\": \"\",\n \"error_description\": \"\"\n }\n }\n ],\n \"device_verification_enabled\": \"\"\n },\n {\n \"id\": \"\",\n \"site_id\": \"\",\n \"site_name\": \"\",\n \"user_name\": \"\",\n \"first_name\": \"\",\n \"last_name\": \"\",\n \"user_status\": \"\",\n \"default_account_id\": \"\",\n \"default_account_name\": \"\",\n \"language_culture\": \"\",\n \"selected_languages\": \"\",\n \"federated_status\": \"\",\n \"is_organization_admin\": \"\",\n \"created_on\": \"\",\n \"last_login\": \"\",\n \"memberships\": [\n {\n \"email\": \"\",\n \"account_id\": \"\",\n \"external_account_id\": \"\",\n \"account_name\": \"\",\n \"is_external_account\": \"\",\n \"status\": \"\",\n \"permission_profile\": {\n \"id\": \"\",\n \"name\": \"\"\n },\n \"created_on\": \"\",\n \"groups\": [\n {\n \"id\": \"\",\n \"name\": \"\",\n \"type\": \"\"\n },\n {\n \"id\": \"\",\n \"name\": \"\",\n \"type\": \"\"\n }\n ],\n \"is_admin\": \"\"\n },\n {\n \"email\": \"\",\n \"account_id\": \"\",\n \"external_account_id\": \"\",\n \"account_name\": \"\",\n \"is_external_account\": \"\",\n \"status\": \"\",\n \"permission_profile\": {\n \"id\": \"\",\n \"name\": \"\"\n },\n \"created_on\": \"\",\n \"groups\": [\n {\n \"id\": \"\",\n \"name\": \"\",\n \"type\": \"\"\n },\n {\n \"id\": \"\",\n \"name\": \"\",\n \"type\": \"\"\n }\n ],\n \"is_admin\": \"\"\n }\n ],\n \"identities\": [\n {\n \"id\": \"\",\n \"provider_id\": \"\",\n \"user_id\": \"\",\n \"immutable_id\": \"\",\n \"error_details\": {\n \"error\": \"\",\n \"error_description\": \"\"\n }\n },\n {\n \"id\": \"\",\n \"provider_id\": \"\",\n \"user_id\": \"\",\n \"immutable_id\": \"\",\n \"error_details\": {\n \"error\": \"\",\n \"error_description\": \"\"\n }\n }\n ],\n \"device_verification_enabled\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } }, { - "_postman_id": "b72412dd-da45-4f41-aaab-90282de321ba", - "name": "Creates a new User List Export request.", + "id": "8568c150-175a-4762-98b7-8cbdabb46edf", + "name": "Remove user from permission profiles for one or more products", "request": { + "name": "Revokes a user's access to one or more products.", + "description": { + "content": "Required scopes: user_write", + "type": "text/markdown" + }, "url": { - "raw": "https://{{hostenv}}/Management/v2/organizations/{{organizationId}}/exports/user_list", - "protocol": "https", - "auth": {}, - "host": [ - "{{hostenv}}" - ], "path": [ - "Management", - "v2", + "v2.1", "organizations", - "{{organizationId}}", - "exports", - "user_list" + ":organizationId", + "accounts", + ":accountId", + "products", + "users" ], + "host": [ + "{{baseUrl}}" + ], + "query": [], "variable": [ { - "value": "{{organizationId}}", - "id": "organizationId" + "type": "any", + "value": "", + "key": "organizationId", + "disabled": false, + "description": { + "content": "(Required) The organization ID GUID", + "type": "text/plain" + } + }, + { + "type": "any", + "value": "", + "key": "accountId", + "disabled": false, + "description": { + "content": "(Required) The account ID GUID.", + "type": "text/plain" + } } ] }, - "method": "POST", "header": [ - { - "key": "Accept", - "value": "application/json", - "description": "" - }, { "key": "Content-Type", - "value": "application/json", - "description": "" + "value": "application/json" }, { - "key": "Authorization", - "value": "Bearer {{accessToken}}", - "description": "" + "key": "Accept", + "value": "application/json" } ], + "method": "DELETE", "body": { "mode": "raw", - "raw": "{}" + "raw": "{\n \"product_ids\": [\n \"\",\n \"\"\n ],\n \"user_email\": \"\",\n \"user_id\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } }, - "description": "Required scopes: user_read" + "auth": null }, - "response": [] + "response": [ + { + "id": "1f86f425-0a47-4e4f-a13e-88dad2c6d50d", + "name": "OK", + "originalRequest": { + "url": { + "path": [ + "v2.1", + "organizations", + ":organizationId", + "accounts", + ":accountId", + "products", + "users" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "DELETE", + "body": { + "mode": "raw", + "raw": "{\n \"product_ids\": [\n \"\",\n \"\"\n ],\n \"user_email\": \"\",\n \"user_id\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "OK", + "code": 200, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"is_success\": \"\",\n \"user_product_results\": {\n \"ea6e1\": \"\"\n },\n \"user_email\": \"\",\n \"user_id\": \"\"\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } }, { - "_postman_id": "c0c82b8b-fa00-4e24-b03a-6f626fcafc74", - "name": "Returns the details/metadata for Account Setting Export requests", + "id": "bfc965b2-3cc5-4bbc-a689-68bad7f0a42a", + "name": "Remove user from permission profiles for one or more products", "request": { + "name": "Retrieves a user's product permission profiles by email address.", + "description": { + "content": "Required scopes: user_write", + "type": "text/markdown" + }, "url": { - "raw": "https://{{hostenv}}/Management/v2/organizations/{{organizationId}}/exports/account_settings", - "protocol": "https", - "auth": {}, - "host": [ - "{{hostenv}}" - ], "path": [ - "Management", - "v2", + "v2.1", "organizations", - "{{organizationId}}", - "exports", - "account_settings" + ":organizationId", + "accounts", + ":accountId", + "products", + "permission_profiles", + "users" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": true, + "description": { + "content": "The email address of the user.\n\n**Note:** This property is required.", + "type": "text/plain" + }, + "key": "email", + "value": "" + } ], "variable": [ { - "value": "{{organizationId}}", - "id": "organizationId" + "type": "any", + "value": "", + "key": "organizationId", + "disabled": false, + "description": { + "content": "(Required) The organization ID GUID", + "type": "text/plain" + } + }, + { + "type": "any", + "value": "", + "key": "accountId", + "disabled": false, + "description": { + "content": "(Required) The account ID GUID.", + "type": "text/plain" + } } ] }, - "method": "GET", "header": [ { "key": "Accept", - "value": "application/json", - "description": "" - }, - { - "key": "Content-Type", - "value": "application/json", - "description": "" - }, - { - "key": "Authorization", - "value": "Bearer {{accessToken}}", - "description": "" + "value": "application/json" } ], - "body": { - "mode": "raw", - "raw": "{}" - }, - "description": "Required scopes: account_read" + "method": "GET", + "body": {}, + "auth": null }, - "response": [] + "response": [ + { + "id": "254c69a1-b1af-45f3-8a11-94630c6e1120", + "name": "OK", + "originalRequest": { + "url": { + "path": [ + "v2.1", + "organizations", + ":organizationId", + "accounts", + ":accountId", + "products", + "permission_profiles", + "users" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": true, + "description": { + "content": "The email address of the user.\n\n**Note:** This property is required.", + "type": "text/plain" + }, + "key": "email", + "value": "" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "GET", + "body": {} + }, + "status": "OK", + "code": 200, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"user_id\": \"\",\n \"account_id\": \"\",\n \"product_permission_profiles\": [\n {\n \"product_id\": \"\",\n \"product_name\": \"\",\n \"permission_profiles\": [\n {\n \"permission_profile_id\": \"\",\n \"permission_profile_name\": \"\"\n },\n {\n \"permission_profile_id\": \"\",\n \"permission_profile_name\": \"\"\n }\n ],\n \"error_message\": \"\"\n },\n {\n \"product_id\": \"\",\n \"product_name\": \"\",\n \"permission_profiles\": [\n {\n \"permission_profile_id\": \"\",\n \"permission_profile_name\": \"\"\n },\n {\n \"permission_profile_id\": \"\",\n \"permission_profile_name\": \"\"\n }\n ],\n \"error_message\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } }, { - "_postman_id": "46d64dcd-3092-4930-a3ff-53d8c2774f5d", - "name": "Creates a new Account Setting Export request.", + "id": "e50af85a-6a84-4481-81ac-7a8c48986c27", + "name": "Assign user to permission profiles for one or more products", "request": { + "name": "Assigns permission profiles for a user by email address.", + "description": { + "content": "Required scopes: user_write", + "type": "text/markdown" + }, "url": { - "raw": "https://{{hostenv}}/Management/v2/organizations/{{organizationId}}/exports/account_settings", - "protocol": "https", - "auth": {}, - "host": [ - "{{hostenv}}" - ], "path": [ - "Management", - "v2", + "v2.1", "organizations", - "{{organizationId}}", - "exports", - "account_settings" + ":organizationId", + "accounts", + ":accountId", + "products", + "permission_profiles", + "users" ], + "host": [ + "{{baseUrl}}" + ], + "query": [], "variable": [ { - "value": "{{organizationId}}", - "id": "organizationId" + "type": "any", + "value": "", + "key": "organizationId", + "disabled": false, + "description": { + "content": "(Required) The organization ID GUID", + "type": "text/plain" + } + }, + { + "type": "any", + "value": "", + "key": "accountId", + "disabled": false, + "description": { + "content": "(Required) The account ID GUID.", + "type": "text/plain" + } } ] }, - "method": "POST", "header": [ - { - "key": "Accept", - "value": "application/json", - "description": "" - }, { "key": "Content-Type", - "value": "application/json", - "description": "" + "value": "application/json" }, { - "key": "Authorization", - "value": "Bearer {{accessToken}}", - "description": "" + "key": "Accept", + "value": "application/json" } ], + "method": "POST", "body": { "mode": "raw", - "raw": "{}" + "raw": "{\n \"email\": \"\",\n \"product_permission_profiles\": [\n {\n \"product_id\": \"\",\n \"permission_profile_id\": \"\"\n },\n {\n \"product_id\": \"\",\n \"permission_profile_id\": \"\"\n }\n ]\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } }, - "description": "Required scopes: account_read" + "auth": null }, - "response": [] - }, + "response": [ + { + "id": "084961f5-62dc-4631-9a2d-cf8ccef37357", + "name": "OK", + "originalRequest": { + "url": { + "path": [ + "v2.1", + "organizations", + ":organizationId", + "accounts", + ":accountId", + "products", + "permission_profiles", + "users" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"email\": \"\",\n \"product_permission_profiles\": [\n {\n \"product_id\": \"\",\n \"permission_profile_id\": \"\"\n },\n {\n \"product_id\": \"\",\n \"permission_profile_id\": \"\"\n }\n ]\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "OK", + "code": 200, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"user_id\": \"\",\n \"account_id\": \"\",\n \"product_permission_profiles\": [\n {\n \"product_id\": \"\",\n \"product_name\": \"\",\n \"permission_profiles\": [\n {\n \"permission_profile_id\": \"\",\n \"permission_profile_name\": \"\"\n },\n {\n \"permission_profile_id\": \"\",\n \"permission_profile_name\": \"\"\n }\n ],\n \"error_message\": \"\"\n },\n {\n \"product_id\": \"\",\n \"product_name\": \"\",\n \"permission_profiles\": [\n {\n \"permission_profile_id\": \"\",\n \"permission_profile_name\": \"\"\n },\n {\n \"permission_profile_id\": \"\",\n \"permission_profile_name\": \"\"\n }\n ],\n \"error_message\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + } + ] + }, + { + "name": "UserExport", + "description": "Methods for exporting a user list.", + "item": [ { - "_postman_id": "9aff4c60-c434-4b24-b5c1-5b407fce566a", - "name": "Returns the details/metadata for a single User List Export request", + "id": "d5b71573-6b77-46fd-b796-63c107d3caf3", + "name": "Returns a list of existing User List Exports (requests and completed exports) and their details/metadata", "request": { + "name": "Returns a list of pending and completed export requests.", + "description": { + "content": "Required scopes: user_read", + "type": "text/markdown" + }, "url": { - "raw": "https://{{hostenv}}/Management/v2/organizations/{{organizationId}}/exports/user_list/{{exportId}}", - "protocol": "https", - "auth": {}, - "host": [ - "{{hostenv}}" - ], "path": [ - "Management", "v2", "organizations", - "{{organizationId}}", + ":organizationId", "exports", - "user_list", - "{{exportId}}" + "user_list" ], - "variable": [ - { - "value": "{{organizationId}}", - "id": "organizationId" - }, + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [ { - "value": "{{exportId}}", - "id": "exportId" + "type": "any", + "value": "", + "key": "organizationId", + "disabled": false, + "description": { + "content": "(Required) The organization ID Guid", + "type": "text/plain" + } } ] }, - "method": "GET", "header": [ { "key": "Accept", - "value": "application/json", - "description": "" - }, - { - "key": "Content-Type", - "value": "application/json", - "description": "" - }, - { - "key": "Authorization", - "value": "Bearer {{accessToken}}", - "description": "" + "value": "application/json" } ], - "body": { - "mode": "raw", - "raw": "{}" - }, - "description": "Required scopes: user_read" + "method": "GET", + "body": {}, + "auth": null }, - "response": [] + "response": [ + { + "id": "685427b7-bdf9-4c58-af0b-9e6a3e5fc8b9", + "name": "OK", + "originalRequest": { + "url": { + "path": [ + "v2", + "organizations", + ":organizationId", + "exports", + "user_list" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "GET", + "body": {} + }, + "status": "OK", + "code": 200, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"exports\": [\n {\n \"id\": \"\",\n \"type\": \"\",\n \"requestor\": {\n \"name\": \"\",\n \"id\": \"\",\n \"type\": \"\",\n \"email\": \"\"\n },\n \"created\": \"\",\n \"last_modified\": \"\",\n \"completed\": \"\",\n \"expires\": \"\",\n \"status\": \"\",\n \"selected_accounts\": [\n {\n \"account_id\": \"\"\n },\n {\n \"account_id\": \"\"\n }\n ],\n \"selected_domains\": [\n {\n \"domain\": \"\"\n },\n {\n \"domain\": \"\"\n }\n ],\n \"metadata_url\": \"\",\n \"percent_completed\": \"\",\n \"number_rows\": \"\",\n \"size_bytes\": \"\",\n \"results\": [\n {\n \"id\": \"\",\n \"site_id\": \"\",\n \"url\": \"\",\n \"number_rows\": \"\",\n \"size_bytes\": \"\",\n \"error_details\": {\n \"error\": \"\",\n \"error_description\": \"\"\n }\n },\n {\n \"id\": \"\",\n \"site_id\": \"\",\n \"url\": \"\",\n \"number_rows\": \"\",\n \"size_bytes\": \"\",\n \"error_details\": {\n \"error\": \"\",\n \"error_description\": \"\"\n }\n }\n ],\n \"success\": \"\"\n },\n {\n \"id\": \"\",\n \"type\": \"\",\n \"requestor\": {\n \"name\": \"\",\n \"id\": \"\",\n \"type\": \"\",\n \"email\": \"\"\n },\n \"created\": \"\",\n \"last_modified\": \"\",\n \"completed\": \"\",\n \"expires\": \"\",\n \"status\": \"\",\n \"selected_accounts\": [\n {\n \"account_id\": \"\"\n },\n {\n \"account_id\": \"\"\n }\n ],\n \"selected_domains\": [\n {\n \"domain\": \"\"\n },\n {\n \"domain\": \"\"\n }\n ],\n \"metadata_url\": \"\",\n \"percent_completed\": \"\",\n \"number_rows\": \"\",\n \"size_bytes\": \"\",\n \"results\": [\n {\n \"id\": \"\",\n \"site_id\": \"\",\n \"url\": \"\",\n \"number_rows\": \"\",\n \"size_bytes\": \"\",\n \"error_details\": {\n \"error\": \"\",\n \"error_description\": \"\"\n }\n },\n {\n \"id\": \"\",\n \"site_id\": \"\",\n \"url\": \"\",\n \"number_rows\": \"\",\n \"size_bytes\": \"\",\n \"error_details\": {\n \"error\": \"\",\n \"error_description\": \"\"\n }\n }\n ],\n \"success\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } }, { - "_postman_id": "a3d1801b-0777-47c0-a584-1a1bc7450fdd", - "name": "Deletes a single User List Export request", + "id": "b72412dd-da45-4f41-aaab-90282de321ba", + "name": "Creates a new User List Export request.", "request": { + "name": "Creates a user list export request.", + "description": { + "content": "Required scopes: user_read", + "type": "text/markdown" + }, "url": { - "raw": "https://{{hostenv}}/Management/v2/organizations/{{organizationId}}/exports/user_list/{{exportId}}", - "protocol": "https", - "auth": {}, - "host": [ - "{{hostenv}}" - ], "path": [ - "Management", "v2", "organizations", - "{{organizationId}}", + ":organizationId", "exports", - "user_list", - "{{exportId}}" + "user_list" + ], + "host": [ + "{{baseUrl}}" ], + "query": [], "variable": [ { - "value": "{{organizationId}}", - "id": "organizationId" - }, - { - "value": "{{exportId}}", - "id": "exportId" + "type": "any", + "value": "", + "key": "organizationId", + "disabled": false, + "description": { + "content": "(Required) The organization ID Guid", + "type": "text/plain" + } } ] }, - "method": "DELETE", "header": [ - { - "key": "Accept", - "value": "application/json", - "description": "" - }, { "key": "Content-Type", - "value": "application/json", - "description": "" + "value": "application/json" }, { - "key": "Authorization", - "value": "Bearer {{accessToken}}", - "description": "" + "key": "Accept", + "value": "application/json" } ], + "method": "POST", "body": { "mode": "raw", - "raw": "{}" + "raw": "{\n \"type\": \"\",\n \"accounts\": [\n {\n \"account_id\": \"\"\n },\n {\n \"account_id\": \"\"\n }\n ],\n \"domains\": [\n {\n \"domain\": \"\"\n },\n {\n \"domain\": \"\"\n }\n ]\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } }, - "description": "Required scopes: user_read" + "auth": null }, - "response": [] + "response": [ + { + "id": "f9d92136-bbca-416c-8f4f-04e44594eafe", + "name": "OK", + "originalRequest": { + "url": { + "path": [ + "v2", + "organizations", + ":organizationId", + "exports", + "user_list" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"type\": \"\",\n \"accounts\": [\n {\n \"account_id\": \"\"\n },\n {\n \"account_id\": \"\"\n }\n ],\n \"domains\": [\n {\n \"domain\": \"\"\n },\n {\n \"domain\": \"\"\n }\n ]\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "OK", + "code": 200, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"id\": \"\",\n \"type\": \"\",\n \"requestor\": {\n \"name\": \"\",\n \"id\": \"\",\n \"type\": \"\",\n \"email\": \"\"\n },\n \"created\": \"\",\n \"last_modified\": \"\",\n \"completed\": \"\",\n \"expires\": \"\",\n \"status\": \"\",\n \"selected_accounts\": [\n {\n \"account_id\": \"\"\n },\n {\n \"account_id\": \"\"\n }\n ],\n \"selected_domains\": [\n {\n \"domain\": \"\"\n },\n {\n \"domain\": \"\"\n }\n ],\n \"metadata_url\": \"\",\n \"percent_completed\": \"\",\n \"number_rows\": \"\",\n \"size_bytes\": \"\",\n \"results\": [\n {\n \"id\": \"\",\n \"site_id\": \"\",\n \"url\": \"\",\n \"number_rows\": \"\",\n \"size_bytes\": \"\",\n \"error_details\": {\n \"error\": \"\",\n \"error_description\": \"\"\n }\n },\n {\n \"id\": \"\",\n \"site_id\": \"\",\n \"url\": \"\",\n \"number_rows\": \"\",\n \"size_bytes\": \"\",\n \"error_details\": {\n \"error\": \"\",\n \"error_description\": \"\"\n }\n }\n ],\n \"success\": \"\"\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } }, { - "_postman_id": "9644a26a-8051-4723-a741-18e9b0bc1b44", - "name": "Returns the details/metadata for a single Account Setting Export request", + "id": "9aff4c60-c434-4b24-b5c1-5b407fce566a", + "name": "Returns the details/metadata for a single User List Export request", "request": { + "name": "Returns the results for single user list export request.", + "description": { + "content": "Required scopes: user_read", + "type": "text/markdown" + }, "url": { - "raw": "https://{{hostenv}}/Management/v2/organizations/{{organizationId}}/exports/account_settings/{{exportId}}", - "protocol": "https", - "auth": {}, - "host": [ - "{{hostenv}}" - ], "path": [ - "Management", "v2", "organizations", - "{{organizationId}}", + ":organizationId", "exports", - "account_settings", - "{{exportId}}" + "user_list", + ":exportId" ], + "host": [ + "{{baseUrl}}" + ], + "query": [], "variable": [ { - "value": "{{organizationId}}", - "id": "organizationId" + "type": "any", + "value": "", + "key": "organizationId", + "disabled": false, + "description": { + "content": "(Required) The organization ID Guid", + "type": "text/plain" + } }, { - "value": "{{exportId}}", - "id": "exportId" + "type": "any", + "value": "", + "key": "exportId", + "disabled": false, + "description": { + "content": "(Required) The export ID GUID for the request.", + "type": "text/plain" + } } ] }, - "method": "GET", "header": [ { "key": "Accept", - "value": "application/json", - "description": "" - }, - { - "key": "Content-Type", - "value": "application/json", - "description": "" - }, - { - "key": "Authorization", - "value": "Bearer {{accessToken}}", - "description": "" + "value": "application/json" } ], - "body": { - "mode": "raw", - "raw": "{}" - }, - "description": "Required scopes: account_read" + "method": "GET", + "body": {}, + "auth": null }, - "response": [] + "response": [ + { + "id": "4e01a4bf-50d5-4dd7-a2a2-eda5a2d37799", + "name": "OK", + "originalRequest": { + "url": { + "path": [ + "v2", + "organizations", + ":organizationId", + "exports", + "user_list", + ":exportId" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "GET", + "body": {} + }, + "status": "OK", + "code": 200, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"id\": \"\",\n \"type\": \"\",\n \"requestor\": {\n \"name\": \"\",\n \"id\": \"\",\n \"type\": \"\",\n \"email\": \"\"\n },\n \"created\": \"\",\n \"last_modified\": \"\",\n \"completed\": \"\",\n \"expires\": \"\",\n \"status\": \"\",\n \"selected_accounts\": [\n {\n \"account_id\": \"\"\n },\n {\n \"account_id\": \"\"\n }\n ],\n \"selected_domains\": [\n {\n \"domain\": \"\"\n },\n {\n \"domain\": \"\"\n }\n ],\n \"metadata_url\": \"\",\n \"percent_completed\": \"\",\n \"number_rows\": \"\",\n \"size_bytes\": \"\",\n \"results\": [\n {\n \"id\": \"\",\n \"site_id\": \"\",\n \"url\": \"\",\n \"number_rows\": \"\",\n \"size_bytes\": \"\",\n \"error_details\": {\n \"error\": \"\",\n \"error_description\": \"\"\n }\n },\n {\n \"id\": \"\",\n \"site_id\": \"\",\n \"url\": \"\",\n \"number_rows\": \"\",\n \"size_bytes\": \"\",\n \"error_details\": {\n \"error\": \"\",\n \"error_description\": \"\"\n }\n }\n ],\n \"success\": \"\"\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } }, { - "_postman_id": "d2fb27ac-cc9c-4e92-b459-1d081d1504e2", - "name": "Deletes a single Account Settings Export request", + "id": "a3d1801b-0777-47c0-a584-1a1bc7450fdd", + "name": "Deletes a single User List Export request", "request": { + "name": "Deletes a single user list export request.", + "description": { + "content": "Required scopes: user_read", + "type": "text/markdown" + }, "url": { - "raw": "https://{{hostenv}}/Management/v2/organizations/{{organizationId}}/exports/account_settings/{{exportId}}", - "protocol": "https", - "auth": {}, - "host": [ - "{{hostenv}}" - ], "path": [ - "Management", "v2", "organizations", - "{{organizationId}}", + ":organizationId", "exports", - "account_settings", - "{{exportId}}" + "user_list", + ":exportId" ], + "host": [ + "{{baseUrl}}" + ], + "query": [], "variable": [ { - "value": "{{organizationId}}", - "id": "organizationId" + "type": "any", + "value": "", + "key": "organizationId", + "disabled": false, + "description": { + "content": "(Required) The organization ID Guid", + "type": "text/plain" + } }, { - "value": "{{exportId}}", - "id": "exportId" + "type": "any", + "value": "", + "key": "exportId", + "disabled": false, + "description": { + "content": "(Required) The export ID GUID for the request.", + "type": "text/plain" + } } ] }, - "method": "DELETE", "header": [ { "key": "Accept", - "value": "application/json", - "description": "" - }, - { - "key": "Content-Type", - "value": "application/json", - "description": "" - }, - { - "key": "Authorization", - "value": "Bearer {{accessToken}}", - "description": "" + "value": "application/json" } ], - "body": { - "mode": "raw", - "raw": "{}" - }, - "description": "Required scopes: account_read" + "method": "DELETE", + "body": {}, + "auth": null }, - "response": [] - }, + "response": [ + { + "id": "6135baa5-1f1d-4c19-be47-293b8c5b87ae", + "name": "OK", + "originalRequest": { + "url": { + "path": [ + "v2", + "organizations", + ":organizationId", + "exports", + "user_list", + ":exportId" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "DELETE", + "body": {} + }, + "status": "OK", + "code": 200, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + } + ] + }, + { + "name": "AccountSettingsExport", + "description": "Methods and objects to get account information.", + "item": [ { - "_postman_id": "3a82a42b-f2de-4723-9b9a-ce1b9ba2e9c5", - "name": "Returns the details/metadata for Bulk Account Settings Import requests in the organization", + "id": "c0c82b8b-fa00-4e24-b03a-6f626fcafc74", + "name": "Returns the details/metadata for Account Setting Export requests", "request": { + "name": "Returns a list of pending and completed account settings export request.", + "description": { + "content": "Required scopes: account_read", + "type": "text/markdown" + }, "url": { - "raw": "https://{{hostenv}}/Management/v2/organizations/{{organizationId}}/imports/account_settings", - "protocol": "https", - "auth": {}, - "host": [ - "{{hostenv}}" - ], "path": [ - "Management", "v2", "organizations", - "{{organizationId}}", - "imports", + ":organizationId", + "exports", "account_settings" ], + "host": [ + "{{baseUrl}}" + ], + "query": [], "variable": [ { - "value": "{{organizationId}}", - "id": "organizationId" + "type": "any", + "value": "", + "key": "organizationId", + "disabled": false, + "description": { + "content": "(Required) The organization ID Guid", + "type": "text/plain" + } } ] }, - "method": "GET", "header": [ { "key": "Accept", - "value": "application/json", - "description": "" - }, - { - "key": "Content-Type", - "value": "application/json", - "description": "" - }, - { - "key": "Authorization", - "value": "Bearer {{accessToken}}", - "description": "" + "value": "application/json" } ], - "body": { - "mode": "raw", - "raw": "{}" - }, - "description": "Required scopes: account_read" + "method": "GET", + "body": {}, + "auth": null }, - "response": [] + "response": [ + { + "id": "f2be4b69-cec2-4d10-9484-4c293a41991d", + "name": "OK", + "originalRequest": { + "url": { + "path": [ + "v2", + "organizations", + ":organizationId", + "exports", + "account_settings" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "GET", + "body": {} + }, + "status": "OK", + "code": 200, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"exports\": [\n {\n \"id\": \"\",\n \"type\": \"\",\n \"requestor\": {\n \"name\": \"\",\n \"id\": \"\",\n \"type\": \"\",\n \"email\": \"\"\n },\n \"created\": \"\",\n \"last_modified\": \"\",\n \"completed\": \"\",\n \"expires\": \"\",\n \"status\": \"\",\n \"selected_accounts\": [\n {\n \"account_id\": \"\"\n },\n {\n \"account_id\": \"\"\n }\n ],\n \"selected_domains\": [\n {\n \"domain\": \"\"\n },\n {\n \"domain\": \"\"\n }\n ],\n \"metadata_url\": \"\",\n \"percent_completed\": \"\",\n \"number_rows\": \"\",\n \"size_bytes\": \"\",\n \"results\": [\n {\n \"id\": \"\",\n \"site_id\": \"\",\n \"url\": \"\",\n \"number_rows\": \"\",\n \"size_bytes\": \"\",\n \"error_details\": {\n \"error\": \"\",\n \"error_description\": \"\"\n }\n },\n {\n \"id\": \"\",\n \"site_id\": \"\",\n \"url\": \"\",\n \"number_rows\": \"\",\n \"size_bytes\": \"\",\n \"error_details\": {\n \"error\": \"\",\n \"error_description\": \"\"\n }\n }\n ],\n \"success\": \"\"\n },\n {\n \"id\": \"\",\n \"type\": \"\",\n \"requestor\": {\n \"name\": \"\",\n \"id\": \"\",\n \"type\": \"\",\n \"email\": \"\"\n },\n \"created\": \"\",\n \"last_modified\": \"\",\n \"completed\": \"\",\n \"expires\": \"\",\n \"status\": \"\",\n \"selected_accounts\": [\n {\n \"account_id\": \"\"\n },\n {\n \"account_id\": \"\"\n }\n ],\n \"selected_domains\": [\n {\n \"domain\": \"\"\n },\n {\n \"domain\": \"\"\n }\n ],\n \"metadata_url\": \"\",\n \"percent_completed\": \"\",\n \"number_rows\": \"\",\n \"size_bytes\": \"\",\n \"results\": [\n {\n \"id\": \"\",\n \"site_id\": \"\",\n \"url\": \"\",\n \"number_rows\": \"\",\n \"size_bytes\": \"\",\n \"error_details\": {\n \"error\": \"\",\n \"error_description\": \"\"\n }\n },\n {\n \"id\": \"\",\n \"site_id\": \"\",\n \"url\": \"\",\n \"number_rows\": \"\",\n \"size_bytes\": \"\",\n \"error_details\": {\n \"error\": \"\",\n \"error_description\": \"\"\n }\n }\n ],\n \"success\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } }, { - "_postman_id": "c3d4b7d9-2f71-4515-97ab-5d8560646d44", - "name": "Creates a new account settings import request.", + "id": "46d64dcd-3092-4930-a3ff-53d8c2774f5d", + "name": "Creates a new Account Setting Export request.", "request": { + "name": "Creates a new account settings export request.", + "description": { + "content": "Required scopes: account_read", + "type": "text/markdown" + }, "url": { - "raw": "https://{{hostenv}}/Management/v2/organizations/{{organizationId}}/imports/account_settings", - "protocol": "https", - "auth": {}, - "host": [ - "{{hostenv}}" - ], "path": [ - "Management", "v2", "organizations", - "{{organizationId}}", - "imports", + ":organizationId", + "exports", "account_settings" ], + "host": [ + "{{baseUrl}}" + ], + "query": [], "variable": [ { - "value": "{{organizationId}}", - "id": "organizationId" + "type": "any", + "value": "", + "key": "organizationId", + "disabled": false, + "description": { + "content": "(Required) The organization ID Guid", + "type": "text/plain" + } } ] }, - "method": "POST", "header": [ - { - "key": "Accept", - "value": "application/json", - "description": "" - }, { "key": "Content-Type", - "value": "multipart/form-data", - "description": "" + "value": "application/json" }, { - "key": "Authorization", - "value": "Bearer {{accessToken}}", - "description": "" + "key": "Accept", + "value": "application/json" } ], + "method": "POST", "body": { "mode": "raw", - "raw": "{}" + "raw": "{\n \"accounts\": [\n {\n \"account_id\": \"\"\n },\n {\n \"account_id\": \"\"\n }\n ]\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } }, - "description": "Required scopes: account_write" + "auth": null }, - "response": [] + "response": [ + { + "id": "3084c857-fc59-4f22-b0e3-1f62c9a40215", + "name": "OK", + "originalRequest": { + "url": { + "path": [ + "v2", + "organizations", + ":organizationId", + "exports", + "account_settings" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"accounts\": [\n {\n \"account_id\": \"\"\n },\n {\n \"account_id\": \"\"\n }\n ]\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "OK", + "code": 200, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"id\": \"\",\n \"type\": \"\",\n \"requestor\": {\n \"name\": \"\",\n \"id\": \"\",\n \"type\": \"\",\n \"email\": \"\"\n },\n \"created\": \"\",\n \"last_modified\": \"\",\n \"completed\": \"\",\n \"expires\": \"\",\n \"status\": \"\",\n \"selected_accounts\": [\n {\n \"account_id\": \"\"\n },\n {\n \"account_id\": \"\"\n }\n ],\n \"selected_domains\": [\n {\n \"domain\": \"\"\n },\n {\n \"domain\": \"\"\n }\n ],\n \"metadata_url\": \"\",\n \"percent_completed\": \"\",\n \"number_rows\": \"\",\n \"size_bytes\": \"\",\n \"results\": [\n {\n \"id\": \"\",\n \"site_id\": \"\",\n \"url\": \"\",\n \"number_rows\": \"\",\n \"size_bytes\": \"\",\n \"error_details\": {\n \"error\": \"\",\n \"error_description\": \"\"\n }\n },\n {\n \"id\": \"\",\n \"site_id\": \"\",\n \"url\": \"\",\n \"number_rows\": \"\",\n \"size_bytes\": \"\",\n \"error_details\": {\n \"error\": \"\",\n \"error_description\": \"\"\n }\n }\n ],\n \"success\": \"\"\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } }, { - "_postman_id": "19cd97d5-3508-47b3-9d5f-95bdf13c3b96", - "name": "Returns the details/metadata for a Bulk Account Settings Import request", + "id": "9644a26a-8051-4723-a741-18e9b0bc1b44", + "name": "Returns the details/metadata for a single Account Setting Export request", "request": { + "name": "Returns the results for a single account settings export request.", + "description": { + "content": "Required scopes: account_read", + "type": "text/markdown" + }, "url": { - "raw": "https://{{hostenv}}/Management/v2/organizations/{{organizationId}}/imports/account_settings/{{importId}}", - "protocol": "https", - "auth": {}, - "host": [ - "{{hostenv}}" - ], "path": [ - "Management", "v2", "organizations", - "{{organizationId}}", - "imports", + ":organizationId", + "exports", "account_settings", - "{{importId}}" + ":exportId" + ], + "host": [ + "{{baseUrl}}" ], + "query": [], "variable": [ { - "value": "{{organizationId}}", - "id": "organizationId" + "type": "any", + "value": "", + "key": "organizationId", + "disabled": false, + "description": { + "content": "(Required) The organization ID Guid", + "type": "text/plain" + } }, { - "value": "{{importId}}", - "id": "importId" + "type": "any", + "value": "", + "key": "exportId", + "disabled": false, + "description": { + "content": "(Required) The export ID GUID for the request.", + "type": "text/plain" + } } ] }, - "method": "GET", "header": [ { "key": "Accept", - "value": "application/json", - "description": "" - }, - { - "key": "Content-Type", - "value": "application/json", - "description": "" - }, - { - "key": "Authorization", - "value": "Bearer {{accessToken}}", - "description": "" + "value": "application/json" } ], - "body": { - "mode": "raw", - "raw": "{}" - }, - "description": "Required scopes: account_read" + "method": "GET", + "body": {}, + "auth": null }, - "response": [] + "response": [ + { + "id": "ed494e20-0200-4132-8e0a-03ae4b90b82c", + "name": "OK", + "originalRequest": { + "url": { + "path": [ + "v2", + "organizations", + ":organizationId", + "exports", + "account_settings", + ":exportId" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "GET", + "body": {} + }, + "status": "OK", + "code": 200, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"id\": \"\",\n \"type\": \"\",\n \"requestor\": {\n \"name\": \"\",\n \"id\": \"\",\n \"type\": \"\",\n \"email\": \"\"\n },\n \"created\": \"\",\n \"last_modified\": \"\",\n \"completed\": \"\",\n \"expires\": \"\",\n \"status\": \"\",\n \"selected_accounts\": [\n {\n \"account_id\": \"\"\n },\n {\n \"account_id\": \"\"\n }\n ],\n \"selected_domains\": [\n {\n \"domain\": \"\"\n },\n {\n \"domain\": \"\"\n }\n ],\n \"metadata_url\": \"\",\n \"percent_completed\": \"\",\n \"number_rows\": \"\",\n \"size_bytes\": \"\",\n \"results\": [\n {\n \"id\": \"\",\n \"site_id\": \"\",\n \"url\": \"\",\n \"number_rows\": \"\",\n \"size_bytes\": \"\",\n \"error_details\": {\n \"error\": \"\",\n \"error_description\": \"\"\n }\n },\n {\n \"id\": \"\",\n \"site_id\": \"\",\n \"url\": \"\",\n \"number_rows\": \"\",\n \"size_bytes\": \"\",\n \"error_details\": {\n \"error\": \"\",\n \"error_description\": \"\"\n }\n }\n ],\n \"success\": \"\"\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } }, { - "_postman_id": "f778a54d-f8a7-4c00-967b-0e1b9fc30a40", - "name": "Deletes a Bulk Account Settings Import request", + "id": "d2fb27ac-cc9c-4e92-b459-1d081d1504e2", + "name": "Deletes a single Account Settings Export request", "request": { + "name": "Deletes a single account settings export request.", + "description": { + "content": "Required scopes: account_read", + "type": "text/markdown" + }, "url": { - "raw": "https://{{hostenv}}/Management/v2/organizations/{{organizationId}}/imports/account_settings/{{importId}}", - "protocol": "https", - "auth": {}, - "host": [ - "{{hostenv}}" - ], "path": [ - "Management", "v2", "organizations", - "{{organizationId}}", - "imports", + ":organizationId", + "exports", "account_settings", - "{{importId}}" + ":exportId" + ], + "host": [ + "{{baseUrl}}" ], + "query": [], "variable": [ { - "value": "{{organizationId}}", - "id": "organizationId" + "type": "any", + "value": "", + "key": "organizationId", + "disabled": false, + "description": { + "content": "(Required) The organization ID Guid", + "type": "text/plain" + } }, { - "value": "{{importId}}", - "id": "importId" + "type": "any", + "value": "", + "key": "exportId", + "disabled": false, + "description": { + "content": "(Required) The export ID GUID for the request.", + "type": "text/plain" + } } ] }, - "method": "DELETE", "header": [ { "key": "Accept", - "value": "application/json", - "description": "" - }, - { - "key": "Content-Type", - "value": "application/json", - "description": "" - }, - { - "key": "Authorization", - "value": "Bearer {{accessToken}}", - "description": "" + "value": "application/json" } ], - "body": { - "mode": "raw", - "raw": "{}" - }, - "description": "Required scopes: account_write" + "method": "DELETE", + "body": {}, + "auth": null }, - "response": [] - }, + "response": [ + { + "id": "21d5069b-5cee-4f91-b5b4-0262f13b1d45", + "name": "OK", + "originalRequest": { + "url": { + "path": [ + "v2", + "organizations", + ":organizationId", + "exports", + "account_settings", + ":exportId" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "DELETE", + "body": {} + }, + "status": "OK", + "code": 200, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + } + ] + }, + { + "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.", + "item": [ { - "_postman_id": "ad6ab554-f564-424b-bdef-d17ccdcc9f91", + "id": "ad6ab554-f564-424b-bdef-d17ccdcc9f91", "name": "Import request for adding users to accounts within the organization.", "request": { + "name": "Creates a request to import new users into an account.", + "description": { + "content": "Required scopes: user_write", + "type": "text/markdown" + }, "url": { - "raw": "https://{{hostenv}}/Management/v2/organizations/{{organizationId}}/imports/bulk_users/add", - "protocol": "https", - "auth": {}, - "host": [ - "{{hostenv}}" - ], "path": [ - "Management", "v2", "organizations", - "{{organizationId}}", + ":organizationId", "imports", "bulk_users", "add" ], + "host": [ + "{{baseUrl}}" + ], + "query": [], "variable": [ { - "value": "{{organizationId}}", - "id": "organizationId" + "type": "any", + "value": "", + "key": "organizationId", + "disabled": false, + "description": { + "content": "(Required) The organization ID Guid", + "type": "text/plain" + } } ] }, - "method": "POST", "header": [ - { - "key": "Accept", - "value": "application/json", - "description": "" - }, { "key": "Content-Type", - "value": "multipart/form-data", - "description": "" + "value": "multipart/form-data" }, { - "key": "Authorization", - "value": "Bearer {{accessToken}}", - "description": "" + "key": "Accept", + "value": "application/json" } ], + "method": "POST", "body": { - "mode": "raw", - "raw": "{}" + "mode": "formdata", + "formdata": [ + { + "description": { + "content": "(Required) CSV file.", + "type": "text/plain" + }, + "key": "file.csv", + "type": "file" + } + ] }, - "description": "Required scopes: user_write" + "auth": null }, - "response": [] - }, - { - "_postman_id": "c92aebd8-5b57-42a9-99dc-ebf36172f5dc", - "name": "Import request for adding user to a single account within the organization. Allows upload of user information without requiring an AccountId column", - "request": { - "url": { - "raw": "https://{{hostenv}}/Management/v2/organizations/{{organizationId}}/accounts/{{accountId}}/imports/bulk_users/add", - "protocol": "https", - "auth": {}, - "host": [ - "{{hostenv}}" - ], - "path": [ - "Management", - "v2", - "organizations", - "{{organizationId}}", - "accounts", - "{{accountId}}", - "imports", - "bulk_users", - "add" - ], - "variable": [ - { - "value": "{{organizationId}}", - "id": "organizationId" + "response": [ + { + "id": "c490807d-7fbf-43b0-b0f4-02f0a6e3b0b1", + "name": "OK", + "originalRequest": { + "url": { + "path": [ + "v2", + "organizations", + ":organizationId", + "imports", + "bulk_users", + "add" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] }, - { - "value": "{{accountId}}", - "id": "accountId" + "header": [ + { + "key": "Content-Type", + "value": "multipart/form-data" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "POST", + "body": { + "mode": "formdata", + "formdata": [ + { + "description": { + "content": "(Required) CSV file.", + "type": "text/plain" + }, + "key": "file.csv", + "type": "file" + } + ] } - ] - }, - "method": "POST", - "header": [ - { - "key": "Accept", - "value": "application/json", - "description": "" }, - { - "key": "Content-Type", - "value": "multipart/form-data", - "description": "" - }, - { - "key": "Authorization", - "value": "Bearer {{accessToken}}", - "description": "" - } - ], - "body": { - "mode": "raw", - "raw": "{}" - }, - "description": "Required scopes: user_write" - }, - "response": [] + "status": "OK", + "code": 200, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"id\": \"\",\n \"type\": \"\",\n \"requestor\": {\n \"name\": \"\",\n \"id\": \"\",\n \"type\": \"\",\n \"email\": \"\"\n },\n \"created\": \"\",\n \"last_modified\": \"\",\n \"status\": \"\",\n \"user_count\": \"\",\n \"processed_user_count\": \"\",\n \"added_user_count\": \"\",\n \"updated_user_count\": \"\",\n \"closed_user_count\": \"\",\n \"no_action_required_user_count\": \"\",\n \"error_count\": \"\",\n \"warning_count\": \"\",\n \"invalid_column_headers\": \"\",\n \"imports_not_found_or_not_available_for_accounts\": \"\",\n \"imports_failed_for_accounts\": \"\",\n \"imports_timed_out_for_accounts\": \"\",\n \"imports_not_found_or_not_available_for_sites\": \"\",\n \"imports_failed_for_sites\": \"\",\n \"imports_timed_out_for_sites\": \"\",\n \"file_level_error_rollups\": [\n {\n \"error_type\": \"\",\n \"count\": \"\"\n },\n {\n \"error_type\": \"\",\n \"count\": \"\"\n }\n ],\n \"user_level_error_rollups\": [\n {\n \"error_type\": \"\",\n \"count\": \"\"\n },\n {\n \"error_type\": \"\",\n \"count\": \"\"\n }\n ],\n \"user_level_warning_rollups\": [\n {\n \"warning_type\": \"\",\n \"count\": \"\"\n },\n {\n \"warning_type\": \"\",\n \"count\": \"\"\n }\n ],\n \"has_csv_results\": \"\",\n \"results_uri\": \"\"\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } }, { - "_postman_id": "d68c76f8-85af-4d9b-96af-463d3a61dcca", + "id": "d68c76f8-85af-4d9b-96af-463d3a61dcca", "name": "Import request for updating users to accounts within the organization.", "request": { + "name": "Bulk updates information for existing users.", + "description": { + "content": "Required scopes: user_write", + "type": "text/markdown" + }, "url": { - "raw": "https://{{hostenv}}/Management/v2/organizations/{{organizationId}}/imports/bulk_users/update", - "protocol": "https", - "auth": {}, - "host": [ - "{{hostenv}}" - ], "path": [ - "Management", "v2", "organizations", - "{{organizationId}}", + ":organizationId", "imports", "bulk_users", "update" ], + "host": [ + "{{baseUrl}}" + ], + "query": [], "variable": [ { - "value": "{{organizationId}}", - "id": "organizationId" + "type": "any", + "value": "", + "key": "organizationId", + "disabled": false, + "description": { + "content": "(Required) The organization ID Guid", + "type": "text/plain" + } } ] }, - "method": "POST", "header": [ - { - "key": "Accept", - "value": "application/json", - "description": "" - }, { "key": "Content-Type", - "value": "multipart/form-data", - "description": "" + "value": "multipart/form-data" }, { - "key": "Authorization", - "value": "Bearer {{accessToken}}", - "description": "" + "key": "Accept", + "value": "application/json" } ], + "method": "POST", "body": { - "mode": "raw", - "raw": "{}" - }, - "description": "Required scopes: user_write" - }, - "response": [] - }, - { - "_postman_id": "1c942220-b1fb-43ae-b963-24f7ba20a861", - "name": "Import request for updating users for a single account within the organization. Allows upload of user information without requiring an AccountId column", - "request": { - "url": { - "raw": "https://{{hostenv}}/Management/v2/organizations/{{organizationId}}/accounts/{{accountId}}/imports/bulk_users/update", - "protocol": "https", - "auth": {}, - "host": [ - "{{hostenv}}" - ], - "path": [ - "Management", - "v2", - "organizations", - "{{organizationId}}", - "accounts", - "{{accountId}}", - "imports", - "bulk_users", - "update" - ], - "variable": [ - { - "value": "{{organizationId}}", - "id": "organizationId" - }, + "mode": "formdata", + "formdata": [ { - "value": "{{accountId}}", - "id": "accountId" + "description": { + "content": "(Required) CSV file.", + "type": "text/plain" + }, + "key": "file.csv", + "type": "file" } ] }, - "method": "POST", - "header": [ - { - "key": "Accept", - "value": "application/json", - "description": "" - }, - { - "key": "Content-Type", - "value": "multipart/form-data", - "description": "" - }, - { - "key": "Authorization", - "value": "Bearer {{accessToken}}", - "description": "" - } - ], - "body": { - "mode": "raw", - "raw": "{}" - }, - "description": "Required scopes: user_write" + "auth": null }, - "response": [] + "response": [ + { + "id": "d4390fd8-4183-4384-a7d2-083956e0e4dc", + "name": "OK", + "originalRequest": { + "url": { + "path": [ + "v2", + "organizations", + ":organizationId", + "imports", + "bulk_users", + "update" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "multipart/form-data" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "POST", + "body": { + "mode": "formdata", + "formdata": [ + { + "description": { + "content": "(Required) CSV file.", + "type": "text/plain" + }, + "key": "file.csv", + "type": "file" + } + ] + } + }, + "status": "OK", + "code": 200, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"id\": \"\",\n \"type\": \"\",\n \"requestor\": {\n \"name\": \"\",\n \"id\": \"\",\n \"type\": \"\",\n \"email\": \"\"\n },\n \"created\": \"\",\n \"last_modified\": \"\",\n \"status\": \"\",\n \"user_count\": \"\",\n \"processed_user_count\": \"\",\n \"added_user_count\": \"\",\n \"updated_user_count\": \"\",\n \"closed_user_count\": \"\",\n \"no_action_required_user_count\": \"\",\n \"error_count\": \"\",\n \"warning_count\": \"\",\n \"invalid_column_headers\": \"\",\n \"imports_not_found_or_not_available_for_accounts\": \"\",\n \"imports_failed_for_accounts\": \"\",\n \"imports_timed_out_for_accounts\": \"\",\n \"imports_not_found_or_not_available_for_sites\": \"\",\n \"imports_failed_for_sites\": \"\",\n \"imports_timed_out_for_sites\": \"\",\n \"file_level_error_rollups\": [\n {\n \"error_type\": \"\",\n \"count\": \"\"\n },\n {\n \"error_type\": \"\",\n \"count\": \"\"\n }\n ],\n \"user_level_error_rollups\": [\n {\n \"error_type\": \"\",\n \"count\": \"\"\n },\n {\n \"error_type\": \"\",\n \"count\": \"\"\n }\n ],\n \"user_level_warning_rollups\": [\n {\n \"warning_type\": \"\",\n \"count\": \"\"\n },\n {\n \"warning_type\": \"\",\n \"count\": \"\"\n }\n ],\n \"has_csv_results\": \"\",\n \"results_uri\": \"\"\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } }, { - "_postman_id": "fa2eb8eb-9913-47da-b8b3-6c4eb47245db", + "id": "fa2eb8eb-9913-47da-b8b3-6c4eb47245db", "name": "Closes the Bulk User Import request", "request": { + "name": "Creates a request to close the accounts of existing users.", + "description": { + "content": "Required scopes: user_write", + "type": "text/markdown" + }, "url": { - "raw": "https://{{hostenv}}/Management/v2/organizations/{{organizationId}}/imports/bulk_users/close", - "protocol": "https", - "auth": {}, - "host": [ - "{{hostenv}}" - ], "path": [ - "Management", "v2", "organizations", - "{{organizationId}}", + ":organizationId", "imports", "bulk_users", "close" ], + "host": [ + "{{baseUrl}}" + ], + "query": [], "variable": [ { - "value": "{{organizationId}}", - "id": "organizationId" + "type": "any", + "value": "", + "key": "organizationId", + "disabled": false, + "description": { + "content": "(Required) The organization ID Guid", + "type": "text/plain" + } } ] }, - "method": "POST", "header": [ - { - "key": "Accept", - "value": "application/json", - "description": "" - }, { "key": "Content-Type", - "value": "multipart/form-data", - "description": "" + "value": "multipart/form-data" }, { - "key": "Authorization", - "value": "Bearer {{accessToken}}", - "description": "" + "key": "Accept", + "value": "application/json" } ], + "method": "POST", "body": { - "mode": "raw", - "raw": "{}" + "mode": "formdata", + "formdata": [ + { + "description": { + "content": "(Required) CSV file.", + "type": "text/plain" + }, + "key": "file.csv", + "type": "file" + } + ] }, - "description": "Required scopes: user_write" + "auth": null }, - "response": [] + "response": [ + { + "id": "e74ffb53-62dd-4114-80f0-83ab4258f45b", + "name": "OK", + "originalRequest": { + "url": { + "path": [ + "v2", + "organizations", + ":organizationId", + "imports", + "bulk_users", + "close" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "multipart/form-data" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "POST", + "body": { + "mode": "formdata", + "formdata": [ + { + "description": { + "content": "(Required) CSV file.", + "type": "text/plain" + }, + "key": "file.csv", + "type": "file" + } + ] + } + }, + "status": "OK", + "code": 200, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"id\": \"\",\n \"type\": \"\",\n \"requestor\": {\n \"name\": \"\",\n \"id\": \"\",\n \"type\": \"\",\n \"email\": \"\"\n },\n \"created\": \"\",\n \"last_modified\": \"\",\n \"status\": \"\",\n \"user_count\": \"\",\n \"processed_user_count\": \"\",\n \"added_user_count\": \"\",\n \"updated_user_count\": \"\",\n \"closed_user_count\": \"\",\n \"no_action_required_user_count\": \"\",\n \"error_count\": \"\",\n \"warning_count\": \"\",\n \"invalid_column_headers\": \"\",\n \"imports_not_found_or_not_available_for_accounts\": \"\",\n \"imports_failed_for_accounts\": \"\",\n \"imports_timed_out_for_accounts\": \"\",\n \"imports_not_found_or_not_available_for_sites\": \"\",\n \"imports_failed_for_sites\": \"\",\n \"imports_timed_out_for_sites\": \"\",\n \"file_level_error_rollups\": [\n {\n \"error_type\": \"\",\n \"count\": \"\"\n },\n {\n \"error_type\": \"\",\n \"count\": \"\"\n }\n ],\n \"user_level_error_rollups\": [\n {\n \"error_type\": \"\",\n \"count\": \"\"\n },\n {\n \"error_type\": \"\",\n \"count\": \"\"\n }\n ],\n \"user_level_warning_rollups\": [\n {\n \"warning_type\": \"\",\n \"count\": \"\"\n },\n {\n \"warning_type\": \"\",\n \"count\": \"\"\n }\n ],\n \"has_csv_results\": \"\",\n \"results_uri\": \"\"\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } }, { - "_postman_id": "9599df6c-0db8-4f29-bcf4-7eb58b59f706", + "id": "9599df6c-0db8-4f29-bcf4-7eb58b59f706", "name": "Closes memberships which are not in an account which is part of the organization, but which do have email addresses which are @ a verified reserved web domain which belongs to the organization", "request": { + "name": "Closes external memberships.", + "description": { + "content": "Required scopes: user_write", + "type": "text/markdown" + }, "url": { - "raw": "https://{{hostenv}}/Management/v2/organizations/{{organizationId}}/imports/bulk_users/close_external", - "protocol": "https", - "auth": {}, - "host": [ - "{{hostenv}}" - ], "path": [ - "Management", "v2", "organizations", - "{{organizationId}}", + ":organizationId", "imports", "bulk_users", "close_external" ], + "host": [ + "{{baseUrl}}" + ], + "query": [], "variable": [ { - "value": "{{organizationId}}", - "id": "organizationId" + "type": "any", + "value": "", + "key": "organizationId", + "disabled": false, + "description": { + "content": "(Required) The organization ID Guid", + "type": "text/plain" + } } ] }, - "method": "POST", "header": [ { "key": "Accept", - "value": "application/json", - "description": "" - }, - { - "key": "Content-Type", - "value": "application/json", - "description": "" - }, - { - "key": "Authorization", - "value": "Bearer {{accessToken}}", - "description": "" + "value": "application/json" } ], - "body": { - "mode": "raw", - "raw": "{}" - }, - "description": "Required scopes: user_write" + "method": "POST", + "body": {}, + "auth": null }, - "response": [] + "response": [ + { + "id": "332191a7-e134-46a7-8eeb-657ac6afacc9", + "name": "OK", + "originalRequest": { + "url": { + "path": [ + "v2", + "organizations", + ":organizationId", + "imports", + "bulk_users", + "close_external" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "POST", + "body": {} + }, + "status": "OK", + "code": 200, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"id\": \"\",\n \"type\": \"\",\n \"requestor\": {\n \"name\": \"\",\n \"id\": \"\",\n \"type\": \"\",\n \"email\": \"\"\n },\n \"created\": \"\",\n \"last_modified\": \"\",\n \"status\": \"\",\n \"user_count\": \"\",\n \"processed_user_count\": \"\",\n \"added_user_count\": \"\",\n \"updated_user_count\": \"\",\n \"closed_user_count\": \"\",\n \"no_action_required_user_count\": \"\",\n \"error_count\": \"\",\n \"warning_count\": \"\",\n \"invalid_column_headers\": \"\",\n \"imports_not_found_or_not_available_for_accounts\": \"\",\n \"imports_failed_for_accounts\": \"\",\n \"imports_timed_out_for_accounts\": \"\",\n \"imports_not_found_or_not_available_for_sites\": \"\",\n \"imports_failed_for_sites\": \"\",\n \"imports_timed_out_for_sites\": \"\",\n \"file_level_error_rollups\": [\n {\n \"error_type\": \"\",\n \"count\": \"\"\n },\n {\n \"error_type\": \"\",\n \"count\": \"\"\n }\n ],\n \"user_level_error_rollups\": [\n {\n \"error_type\": \"\",\n \"count\": \"\"\n },\n {\n \"error_type\": \"\",\n \"count\": \"\"\n }\n ],\n \"user_level_warning_rollups\": [\n {\n \"warning_type\": \"\",\n \"count\": \"\"\n },\n {\n \"warning_type\": \"\",\n \"count\": \"\"\n }\n ],\n \"has_csv_results\": \"\",\n \"results_uri\": \"\"\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } }, { - "_postman_id": "407627a1-135d-45ec-82b0-fc70624bdd86", + "id": "407627a1-135d-45ec-82b0-fc70624bdd86", "name": "Returns the details/metadata for Bulk User Import requests in the organization", "request": { + "name": "Gets a list of all of the user import requests.", + "description": { + "content": "Required scopes: user_read", + "type": "text/markdown" + }, "url": { - "raw": "https://{{hostenv}}/Management/v2/organizations/{{organizationId}}/imports/bulk_users", - "protocol": "https", - "auth": {}, - "host": [ - "{{hostenv}}" - ], "path": [ - "Management", "v2", "organizations", - "{{organizationId}}", + ":organizationId", "imports", "bulk_users" ], + "host": [ + "{{baseUrl}}" + ], + "query": [], "variable": [ { - "value": "{{organizationId}}", - "id": "organizationId" + "type": "any", + "value": "", + "key": "organizationId", + "disabled": false, + "description": { + "content": "(Required) The organization ID Guid", + "type": "text/plain" + } } ] }, - "method": "GET", "header": [ { "key": "Accept", - "value": "application/json", - "description": "" - }, - { - "key": "Content-Type", - "value": "application/json", - "description": "" - }, - { - "key": "Authorization", - "value": "Bearer {{accessToken}}", - "description": "" + "value": "application/json" } ], - "body": { - "mode": "raw", - "raw": "{}" - }, - "description": "Required scopes: user_read" + "method": "GET", + "body": {}, + "auth": null }, - "response": [] + "response": [ + { + "id": "b22fe5fb-adfd-4e73-86c7-89c25eef81d8", + "name": "OK", + "originalRequest": { + "url": { + "path": [ + "v2", + "organizations", + ":organizationId", + "imports", + "bulk_users" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "GET", + "body": {} + }, + "status": "OK", + "code": 200, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"imports\": [\n {\n \"id\": \"\",\n \"type\": \"\",\n \"requestor\": {\n \"name\": \"\",\n \"id\": \"\",\n \"type\": \"\",\n \"email\": \"\"\n },\n \"created\": \"\",\n \"last_modified\": \"\",\n \"status\": \"\",\n \"user_count\": \"\",\n \"processed_user_count\": \"\",\n \"added_user_count\": \"\",\n \"updated_user_count\": \"\",\n \"closed_user_count\": \"\",\n \"no_action_required_user_count\": \"\",\n \"error_count\": \"\",\n \"warning_count\": \"\",\n \"invalid_column_headers\": \"\",\n \"imports_not_found_or_not_available_for_accounts\": \"\",\n \"imports_failed_for_accounts\": \"\",\n \"imports_timed_out_for_accounts\": \"\",\n \"imports_not_found_or_not_available_for_sites\": \"\",\n \"imports_failed_for_sites\": \"\",\n \"imports_timed_out_for_sites\": \"\",\n \"file_level_error_rollups\": [\n {\n \"error_type\": \"\",\n \"count\": \"\"\n },\n {\n \"error_type\": \"\",\n \"count\": \"\"\n }\n ],\n \"user_level_error_rollups\": [\n {\n \"error_type\": \"\",\n \"count\": \"\"\n },\n {\n \"error_type\": \"\",\n \"count\": \"\"\n }\n ],\n \"user_level_warning_rollups\": [\n {\n \"warning_type\": \"\",\n \"count\": \"\"\n },\n {\n \"warning_type\": \"\",\n \"count\": \"\"\n }\n ],\n \"has_csv_results\": \"\",\n \"results_uri\": \"\"\n },\n {\n \"id\": \"\",\n \"type\": \"\",\n \"requestor\": {\n \"name\": \"\",\n \"id\": \"\",\n \"type\": \"\",\n \"email\": \"\"\n },\n \"created\": \"\",\n \"last_modified\": \"\",\n \"status\": \"\",\n \"user_count\": \"\",\n \"processed_user_count\": \"\",\n \"added_user_count\": \"\",\n \"updated_user_count\": \"\",\n \"closed_user_count\": \"\",\n \"no_action_required_user_count\": \"\",\n \"error_count\": \"\",\n \"warning_count\": \"\",\n \"invalid_column_headers\": \"\",\n \"imports_not_found_or_not_available_for_accounts\": \"\",\n \"imports_failed_for_accounts\": \"\",\n \"imports_timed_out_for_accounts\": \"\",\n \"imports_not_found_or_not_available_for_sites\": \"\",\n \"imports_failed_for_sites\": \"\",\n \"imports_timed_out_for_sites\": \"\",\n \"file_level_error_rollups\": [\n {\n \"error_type\": \"\",\n \"count\": \"\"\n },\n {\n \"error_type\": \"\",\n \"count\": \"\"\n }\n ],\n \"user_level_error_rollups\": [\n {\n \"error_type\": \"\",\n \"count\": \"\"\n },\n {\n \"error_type\": \"\",\n \"count\": \"\"\n }\n ],\n \"user_level_warning_rollups\": [\n {\n \"warning_type\": \"\",\n \"count\": \"\"\n },\n {\n \"warning_type\": \"\",\n \"count\": \"\"\n }\n ],\n \"has_csv_results\": \"\",\n \"results_uri\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } }, { - "_postman_id": "24941e89-2bd4-4ddb-9db2-2c2657cb7b17", + "id": "24941e89-2bd4-4ddb-9db2-2c2657cb7b17", "name": "Returns the details/metadata for a User Import request", "request": { + "name": "Returns the details of a single user import request.", + "description": { + "content": "Required scopes: user_read", + "type": "text/markdown" + }, "url": { - "raw": "https://{{hostenv}}/Management/v2/organizations/{{organizationId}}/imports/bulk_users/{{importId}}", - "protocol": "https", - "auth": {}, - "host": [ - "{{hostenv}}" - ], "path": [ - "Management", "v2", "organizations", - "{{organizationId}}", + ":organizationId", "imports", "bulk_users", - "{{importId}}" + ":importId" ], + "host": [ + "{{baseUrl}}" + ], + "query": [], "variable": [ { - "value": "{{organizationId}}", - "id": "organizationId" + "type": "any", + "value": "", + "key": "organizationId", + "disabled": false, + "description": { + "content": "(Required) The organization ID Guid", + "type": "text/plain" + } }, { - "value": "{{importId}}", - "id": "importId" + "type": "any", + "value": "", + "key": "importId", + "disabled": false, + "description": { + "content": "(Required) The import ID GUID for the request.", + "type": "text/plain" + } } ] }, - "method": "GET", "header": [ { "key": "Accept", - "value": "application/json", - "description": "" - }, - { - "key": "Content-Type", - "value": "application/json", - "description": "" - }, - { - "key": "Authorization", - "value": "Bearer {{accessToken}}", - "description": "" + "value": "application/json" } ], - "body": { - "mode": "raw", - "raw": "{}" - }, - "description": "Required scopes: user_read" + "method": "GET", + "body": {}, + "auth": null }, - "response": [] + "response": [ + { + "id": "cc0f6e23-d1c4-4c1b-8113-9b64fddd9cd8", + "name": "OK", + "originalRequest": { + "url": { + "path": [ + "v2", + "organizations", + ":organizationId", + "imports", + "bulk_users", + ":importId" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "GET", + "body": {} + }, + "status": "OK", + "code": 200, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"id\": \"\",\n \"type\": \"\",\n \"requestor\": {\n \"name\": \"\",\n \"id\": \"\",\n \"type\": \"\",\n \"email\": \"\"\n },\n \"created\": \"\",\n \"last_modified\": \"\",\n \"status\": \"\",\n \"user_count\": \"\",\n \"processed_user_count\": \"\",\n \"added_user_count\": \"\",\n \"updated_user_count\": \"\",\n \"closed_user_count\": \"\",\n \"no_action_required_user_count\": \"\",\n \"error_count\": \"\",\n \"warning_count\": \"\",\n \"invalid_column_headers\": \"\",\n \"imports_not_found_or_not_available_for_accounts\": \"\",\n \"imports_failed_for_accounts\": \"\",\n \"imports_timed_out_for_accounts\": \"\",\n \"imports_not_found_or_not_available_for_sites\": \"\",\n \"imports_failed_for_sites\": \"\",\n \"imports_timed_out_for_sites\": \"\",\n \"file_level_error_rollups\": [\n {\n \"error_type\": \"\",\n \"count\": \"\"\n },\n {\n \"error_type\": \"\",\n \"count\": \"\"\n }\n ],\n \"user_level_error_rollups\": [\n {\n \"error_type\": \"\",\n \"count\": \"\"\n },\n {\n \"error_type\": \"\",\n \"count\": \"\"\n }\n ],\n \"user_level_warning_rollups\": [\n {\n \"warning_type\": \"\",\n \"count\": \"\"\n },\n {\n \"warning_type\": \"\",\n \"count\": \"\"\n }\n ],\n \"has_csv_results\": \"\",\n \"results_uri\": \"\"\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } }, { - "_postman_id": "d6b05db0-9100-4390-98f0-28c132e816dd", + "id": "d6b05db0-9100-4390-98f0-28c132e816dd", "name": "Deletes a User Import request", "request": { + "name": "Deletes a specific user import request.", + "description": { + "content": "Required scopes: user_write", + "type": "text/markdown" + }, "url": { - "raw": "https://{{hostenv}}/Management/v2/organizations/{{organizationId}}/imports/bulk_users/{{importId}}", - "protocol": "https", - "auth": {}, - "host": [ - "{{hostenv}}" - ], "path": [ - "Management", "v2", "organizations", - "{{organizationId}}", + ":organizationId", "imports", "bulk_users", - "{{importId}}" + ":importId" ], + "host": [ + "{{baseUrl}}" + ], + "query": [], "variable": [ { - "value": "{{organizationId}}", - "id": "organizationId" + "type": "any", + "value": "", + "key": "organizationId", + "disabled": false, + "description": { + "content": "(Required) The organization ID Guid", + "type": "text/plain" + } }, { - "value": "{{importId}}", - "id": "importId" + "type": "any", + "value": "", + "key": "importId", + "disabled": false, + "description": { + "content": "(Required) The import ID GUID for the request.", + "type": "text/plain" + } } ] }, - "method": "DELETE", "header": [ { "key": "Accept", - "value": "application/json", - "description": "" - }, - { - "key": "Content-Type", - "value": "application/json", - "description": "" - }, - { - "key": "Authorization", - "value": "Bearer {{accessToken}}", - "description": "" + "value": "application/json" } ], - "body": { - "mode": "raw", - "raw": "{}" - }, - "description": "Required scopes: user_write" + "method": "DELETE", + "body": {}, + "auth": null }, - "response": [] + "response": [ + { + "id": "0bde8bde-b003-4c11-90b4-1b5656c24705", + "name": "OK", + "originalRequest": { + "url": { + "path": [ + "v2", + "organizations", + ":organizationId", + "imports", + "bulk_users", + ":importId" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "DELETE", + "body": {} + }, + "status": "OK", + "code": 200, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } }, { - "_postman_id": "2dbaf5bb-8f9a-4cb7-a5fc-9b5f31e34d6a", + "id": "2dbaf5bb-8f9a-4cb7-a5fc-9b5f31e34d6a", "name": "Returns a text/csv file with user details for a User Import request", "request": { + "name": "Given the ID of a user import request,\nreturn the CSV file that was imported.", + "description": { + "content": "Required scopes: user_read", + "type": "text/markdown" + }, "url": { - "raw": "https://{{hostenv}}/Management/v2/organizations/{{organizationId}}/imports/bulk_users/{{importId}}/results_csv", - "protocol": "https", - "auth": {}, - "host": [ - "{{hostenv}}" - ], "path": [ - "Management", "v2", "organizations", - "{{organizationId}}", + ":organizationId", "imports", "bulk_users", - "{{importId}}", + ":importId", "results_csv" ], + "host": [ + "{{baseUrl}}" + ], + "query": [], "variable": [ { - "value": "{{organizationId}}", - "id": "organizationId" + "type": "any", + "value": "", + "key": "organizationId", + "disabled": false, + "description": { + "content": "(Required) The organization ID Guid", + "type": "text/plain" + } }, { - "value": "{{importId}}", - "id": "importId" + "type": "any", + "value": "", + "key": "importId", + "disabled": false, + "description": { + "content": "(Required) The import ID GUID for the request.", + "type": "text/plain" + } } ] }, - "method": "GET", "header": [ { "key": "Accept", - "value": "text/csv", - "description": "" - }, - { - "key": "Content-Type", - "value": "application/json", - "description": "" - }, - { - "key": "Authorization", - "value": "Bearer {{accessToken}}", - "description": "" + "value": "text/csv" } ], - "body": { - "mode": "raw", - "raw": "{}" - }, - "description": "Required scopes: user_read" + "method": "GET", + "body": {}, + "auth": null }, - "response": [] + "response": [ + { + "id": "72e9151f-e366-4b4e-abae-8259429d8f3b", + "name": "OK", + "originalRequest": { + "url": { + "path": [ + "v2", + "organizations", + ":organizationId", + "imports", + "bulk_users", + ":importId", + "results_csv" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "text/csv" + } + ], + "method": "GET", + "body": {} + }, + "status": "OK", + "code": 200, + "header": [ + { + "key": "Content-Type", + "value": "text/csv" + } + ], + "body": "{}", + "cookie": [], + "_postman_previewlanguage": "text" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } } ] }, { - "_postman_id": "7324da21-ed71-45ce-a4ca-24a40dc9b60a", - "name": "IdentityProviders", - "description": "Folder for IdentityProviders", + "name": "Organization", + "description": "Methods for working with organizations.", "item": [ { - "_postman_id": "0c01ee6a-2408-4ad2-8a72-04e7f7fc2f76", - "name": "Returns the list of identity providers for the organization.", + "id": "a48c1a6a-bef3-4764-a7dc-85e3317aed05", + "name": "Returns a list of organizations that the authenticated user belongs to.", "request": { + "name": "Returns a list of organizations that the authenticated user belongs to.", + "description": { + "content": "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/).", + "type": "text/plain" + }, "url": { - "raw": "https://{{hostenv}}/Management/v2/organizations/{{organizationId}}/identity_providers", - "protocol": "https", - "auth": {}, - "host": [ - "{{hostenv}}" - ], "path": [ - "Management", "v2", - "organizations", - "{{organizationId}}", - "identity_providers" + "organizations" ], - "variable": [ + "host": [ + "{{baseUrl}}" + ], + "query": [ { - "value": "{{organizationId}}", - "id": "organizationId" + "disabled": true, + "description": { + "content": "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`", + "type": "text/plain" + }, + "key": "mode", + "value": "" } - ] + ], + "variable": [] }, - "method": "GET", "header": [ { "key": "Accept", - "value": "application/json", - "description": "" - }, - { - "key": "Content-Type", - "value": "application/json", - "description": "" - }, - { - "key": "Authorization", - "value": "Bearer {{accessToken}}", - "description": "" + "value": "application/json" } ], - "body": { - "mode": "raw", - "raw": "{}" - }, - "description": "Required scopes: identity_provider_read" + "method": "GET", + "body": {}, + "auth": null }, - "response": [] + "response": [ + { + "id": "15a66100-9557-446c-8dcb-effa707e8f85", + "name": "OK", + "originalRequest": { + "url": { + "path": [ + "v2", + "organizations" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": true, + "description": { + "content": "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`", + "type": "text/plain" + }, + "key": "mode", + "value": "" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "GET", + "body": {} + }, + "status": "OK", + "code": 200, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"organizations\": [\n {\n \"id\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"default_account_id\": \"\",\n \"default_permission_profile_id\": \"\",\n \"created_on\": \"\",\n \"created_by\": \"\",\n \"last_modified_on\": \"\",\n \"last_modified_by\": \"\",\n \"accounts\": [\n {\n \"id\": \"\",\n \"name\": \"\",\n \"external_account_id\": \"\",\n \"site_id\": \"\"\n },\n {\n \"id\": \"\",\n \"name\": \"\",\n \"external_account_id\": \"\",\n \"site_id\": \"\"\n }\n ],\n \"users\": [\n {\n \"id\": \"\"\n },\n {\n \"id\": \"\"\n }\n ],\n \"reserved_domains\": [\n {\n \"id\": \"\",\n \"status\": \"\",\n \"host_name\": \"\",\n \"txt_token\": \"\",\n \"identity_provider_id\": \"\",\n \"settings\": [\n {\n \"key\": \"\",\n \"value\": {},\n \"type\": \"\"\n },\n {\n \"key\": \"\",\n \"value\": {},\n \"type\": \"\"\n }\n ],\n \"links\": [\n {\n \"rel\": \"\",\n \"href\": \"\"\n },\n {\n \"rel\": \"\",\n \"href\": \"\"\n }\n ]\n },\n {\n \"id\": \"\",\n \"status\": \"\",\n \"host_name\": \"\",\n \"txt_token\": \"\",\n \"identity_provider_id\": \"\",\n \"settings\": [\n {\n \"key\": \"\",\n \"value\": {},\n \"type\": \"\"\n },\n {\n \"key\": \"\",\n \"value\": {},\n \"type\": \"\"\n }\n ],\n \"links\": [\n {\n \"rel\": \"\",\n \"href\": \"\"\n },\n {\n \"rel\": \"\",\n \"href\": \"\"\n }\n ]\n }\n ],\n \"identity_providers\": [\n {\n \"identity_providers\": [\n {\n \"id\": \"\",\n \"friendly_name\": \"\",\n \"auto_provision_users\": \"\",\n \"type\": \"\",\n \"saml_20\": {\n \"issuer\": \"\",\n \"settings\": [\n {\n \"key\": \"\",\n \"value\": {},\n \"type\": \"\"\n },\n {\n \"key\": \"\",\n \"value\": {},\n \"type\": \"\"\n }\n ],\n \"certificates\": [\n {\n \"id\": \"\",\n \"issuer\": \"\",\n \"thumbprint\": \"\",\n \"expiration_date\": \"\",\n \"is_valid\": \"\",\n \"links\": [\n {\n \"rel\": \"\",\n \"href\": \"\"\n },\n {\n \"rel\": \"\",\n \"href\": \"\"\n }\n ]\n },\n {\n \"id\": \"\",\n \"issuer\": \"\",\n \"thumbprint\": \"\",\n \"expiration_date\": \"\",\n \"is_valid\": \"\",\n \"links\": [\n {\n \"rel\": \"\",\n \"href\": \"\"\n },\n {\n \"rel\": \"\",\n \"href\": \"\"\n }\n ]\n }\n ],\n \"attribute_mappings\": [\n {\n \"required_attribute_id\": \"\",\n \"required_attribute_name\": \"\",\n \"required_attribute_friendly_name\": \"\",\n \"substitute_attribute_name\": \"\"\n },\n {\n \"required_attribute_id\": \"\",\n \"required_attribute_name\": \"\",\n \"required_attribute_friendly_name\": \"\",\n \"substitute_attribute_name\": \"\"\n }\n ]\n },\n \"links\": [\n {\n \"rel\": \"\",\n \"href\": \"\"\n },\n {\n \"rel\": \"\",\n \"href\": \"\"\n }\n ]\n },\n {\n \"id\": \"\",\n \"friendly_name\": \"\",\n \"auto_provision_users\": \"\",\n \"type\": \"\",\n \"saml_20\": {\n \"issuer\": \"\",\n \"settings\": [\n {\n \"key\": \"\",\n \"value\": {},\n \"type\": \"\"\n },\n {\n \"key\": \"\",\n \"value\": {},\n \"type\": \"\"\n }\n ],\n \"certificates\": [\n {\n \"id\": \"\",\n \"issuer\": \"\",\n \"thumbprint\": \"\",\n \"expiration_date\": \"\",\n \"is_valid\": \"\",\n \"links\": [\n {\n \"rel\": \"\",\n \"href\": \"\"\n },\n {\n \"rel\": \"\",\n \"href\": \"\"\n }\n ]\n },\n {\n \"id\": \"\",\n \"issuer\": \"\",\n \"thumbprint\": \"\",\n \"expiration_date\": \"\",\n \"is_valid\": \"\",\n \"links\": [\n {\n \"rel\": \"\",\n \"href\": \"\"\n },\n {\n \"rel\": \"\",\n \"href\": \"\"\n }\n ]\n }\n ],\n \"attribute_mappings\": [\n {\n \"required_attribute_id\": \"\",\n \"required_attribute_name\": \"\",\n \"required_attribute_friendly_name\": \"\",\n \"substitute_attribute_name\": \"\"\n },\n {\n \"required_attribute_id\": \"\",\n \"required_attribute_name\": \"\",\n \"required_attribute_friendly_name\": \"\",\n \"substitute_attribute_name\": \"\"\n }\n ]\n },\n \"links\": [\n {\n \"rel\": \"\",\n \"href\": \"\"\n },\n {\n \"rel\": \"\",\n \"href\": \"\"\n }\n ]\n }\n ]\n },\n {\n \"identity_providers\": [\n {\n \"id\": \"\",\n \"friendly_name\": \"\",\n \"auto_provision_users\": \"\",\n \"type\": \"\",\n \"saml_20\": {\n \"issuer\": \"\",\n \"settings\": [\n {\n \"key\": \"\",\n \"value\": {},\n \"type\": \"\"\n },\n {\n \"key\": \"\",\n \"value\": {},\n \"type\": \"\"\n }\n ],\n \"certificates\": [\n {\n \"id\": \"\",\n \"issuer\": \"\",\n \"thumbprint\": \"\",\n \"expiration_date\": \"\",\n \"is_valid\": \"\",\n \"links\": [\n {\n \"rel\": \"\",\n \"href\": \"\"\n },\n {\n \"rel\": \"\",\n \"href\": \"\"\n }\n ]\n },\n {\n \"id\": \"\",\n \"issuer\": \"\",\n \"thumbprint\": \"\",\n \"expiration_date\": \"\",\n \"is_valid\": \"\",\n \"links\": [\n {\n \"rel\": \"\",\n \"href\": \"\"\n },\n {\n \"rel\": \"\",\n \"href\": \"\"\n }\n ]\n }\n ],\n \"attribute_mappings\": [\n {\n \"required_attribute_id\": \"\",\n \"required_attribute_name\": \"\",\n \"required_attribute_friendly_name\": \"\",\n \"substitute_attribute_name\": \"\"\n },\n {\n \"required_attribute_id\": \"\",\n \"required_attribute_name\": \"\",\n \"required_attribute_friendly_name\": \"\",\n \"substitute_attribute_name\": \"\"\n }\n ]\n },\n \"links\": [\n {\n \"rel\": \"\",\n \"href\": \"\"\n },\n {\n \"rel\": \"\",\n \"href\": \"\"\n }\n ]\n },\n {\n \"id\": \"\",\n \"friendly_name\": \"\",\n \"auto_provision_users\": \"\",\n \"type\": \"\",\n \"saml_20\": {\n \"issuer\": \"\",\n \"settings\": [\n {\n \"key\": \"\",\n \"value\": {},\n \"type\": \"\"\n },\n {\n \"key\": \"\",\n \"value\": {},\n \"type\": \"\"\n }\n ],\n \"certificates\": [\n {\n \"id\": \"\",\n \"issuer\": \"\",\n \"thumbprint\": \"\",\n \"expiration_date\": \"\",\n \"is_valid\": \"\",\n \"links\": [\n {\n \"rel\": \"\",\n \"href\": \"\"\n },\n {\n \"rel\": \"\",\n \"href\": \"\"\n }\n ]\n },\n {\n \"id\": \"\",\n \"issuer\": \"\",\n \"thumbprint\": \"\",\n \"expiration_date\": \"\",\n \"is_valid\": \"\",\n \"links\": [\n {\n \"rel\": \"\",\n \"href\": \"\"\n },\n {\n \"rel\": \"\",\n \"href\": \"\"\n }\n ]\n }\n ],\n \"attribute_mappings\": [\n {\n \"required_attribute_id\": \"\",\n \"required_attribute_name\": \"\",\n \"required_attribute_friendly_name\": \"\",\n \"substitute_attribute_name\": \"\"\n },\n {\n \"required_attribute_id\": \"\",\n \"required_attribute_name\": \"\",\n \"required_attribute_friendly_name\": \"\",\n \"substitute_attribute_name\": \"\"\n }\n ]\n },\n \"links\": [\n {\n \"rel\": \"\",\n \"href\": \"\"\n },\n {\n \"rel\": \"\",\n \"href\": \"\"\n }\n ]\n }\n ]\n }\n ],\n \"links\": [\n {\n \"rel\": \"\",\n \"href\": \"\"\n },\n {\n \"rel\": \"\",\n \"href\": \"\"\n }\n ]\n },\n {\n \"id\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"default_account_id\": \"\",\n \"default_permission_profile_id\": \"\",\n \"created_on\": \"\",\n \"created_by\": \"\",\n \"last_modified_on\": \"\",\n \"last_modified_by\": \"\",\n \"accounts\": [\n {\n \"id\": \"\",\n \"name\": \"\",\n \"external_account_id\": \"\",\n \"site_id\": \"\"\n },\n {\n \"id\": \"\",\n \"name\": \"\",\n \"external_account_id\": \"\",\n \"site_id\": \"\"\n }\n ],\n \"users\": [\n {\n \"id\": \"\"\n },\n {\n \"id\": \"\"\n }\n ],\n \"reserved_domains\": [\n {\n \"id\": \"\",\n \"status\": \"\",\n \"host_name\": \"\",\n \"txt_token\": \"\",\n \"identity_provider_id\": \"\",\n \"settings\": [\n {\n \"key\": \"\",\n \"value\": {},\n \"type\": \"\"\n },\n {\n \"key\": \"\",\n \"value\": {},\n \"type\": \"\"\n }\n ],\n \"links\": [\n {\n \"rel\": \"\",\n \"href\": \"\"\n },\n {\n \"rel\": \"\",\n \"href\": \"\"\n }\n ]\n },\n {\n \"id\": \"\",\n \"status\": \"\",\n \"host_name\": \"\",\n \"txt_token\": \"\",\n \"identity_provider_id\": \"\",\n \"settings\": [\n {\n \"key\": \"\",\n \"value\": {},\n \"type\": \"\"\n },\n {\n \"key\": \"\",\n \"value\": {},\n \"type\": \"\"\n }\n ],\n \"links\": [\n {\n \"rel\": \"\",\n \"href\": \"\"\n },\n {\n \"rel\": \"\",\n \"href\": \"\"\n }\n ]\n }\n ],\n \"identity_providers\": [\n {\n \"identity_providers\": [\n {\n \"id\": \"\",\n \"friendly_name\": \"\",\n \"auto_provision_users\": \"\",\n \"type\": \"\",\n \"saml_20\": {\n \"issuer\": \"\",\n \"settings\": [\n {\n \"key\": \"\",\n \"value\": {},\n \"type\": \"\"\n },\n {\n \"key\": \"\",\n \"value\": {},\n \"type\": \"\"\n }\n ],\n \"certificates\": [\n {\n \"id\": \"\",\n \"issuer\": \"\",\n \"thumbprint\": \"\",\n \"expiration_date\": \"\",\n \"is_valid\": \"\",\n \"links\": [\n {\n \"rel\": \"\",\n \"href\": \"\"\n },\n {\n \"rel\": \"\",\n \"href\": \"\"\n }\n ]\n },\n {\n \"id\": \"\",\n \"issuer\": \"\",\n \"thumbprint\": \"\",\n \"expiration_date\": \"\",\n \"is_valid\": \"\",\n \"links\": [\n {\n \"rel\": \"\",\n \"href\": \"\"\n },\n {\n \"rel\": \"\",\n \"href\": \"\"\n }\n ]\n }\n ],\n \"attribute_mappings\": [\n {\n \"required_attribute_id\": \"\",\n \"required_attribute_name\": \"\",\n \"required_attribute_friendly_name\": \"\",\n \"substitute_attribute_name\": \"\"\n },\n {\n \"required_attribute_id\": \"\",\n \"required_attribute_name\": \"\",\n \"required_attribute_friendly_name\": \"\",\n \"substitute_attribute_name\": \"\"\n }\n ]\n },\n \"links\": [\n {\n \"rel\": \"\",\n \"href\": \"\"\n },\n {\n \"rel\": \"\",\n \"href\": \"\"\n }\n ]\n },\n {\n \"id\": \"\",\n \"friendly_name\": \"\",\n \"auto_provision_users\": \"\",\n \"type\": \"\",\n \"saml_20\": {\n \"issuer\": \"\",\n \"settings\": [\n {\n \"key\": \"\",\n \"value\": {},\n \"type\": \"\"\n },\n {\n \"key\": \"\",\n \"value\": {},\n \"type\": \"\"\n }\n ],\n \"certificates\": [\n {\n \"id\": \"\",\n \"issuer\": \"\",\n \"thumbprint\": \"\",\n \"expiration_date\": \"\",\n \"is_valid\": \"\",\n \"links\": [\n {\n \"rel\": \"\",\n \"href\": \"\"\n },\n {\n \"rel\": \"\",\n \"href\": \"\"\n }\n ]\n },\n {\n \"id\": \"\",\n \"issuer\": \"\",\n \"thumbprint\": \"\",\n \"expiration_date\": \"\",\n \"is_valid\": \"\",\n \"links\": [\n {\n \"rel\": \"\",\n \"href\": \"\"\n },\n {\n \"rel\": \"\",\n \"href\": \"\"\n }\n ]\n }\n ],\n \"attribute_mappings\": [\n {\n \"required_attribute_id\": \"\",\n \"required_attribute_name\": \"\",\n \"required_attribute_friendly_name\": \"\",\n \"substitute_attribute_name\": \"\"\n },\n {\n \"required_attribute_id\": \"\",\n \"required_attribute_name\": \"\",\n \"required_attribute_friendly_name\": \"\",\n \"substitute_attribute_name\": \"\"\n }\n ]\n },\n \"links\": [\n {\n \"rel\": \"\",\n \"href\": \"\"\n },\n {\n \"rel\": \"\",\n \"href\": \"\"\n }\n ]\n }\n ]\n },\n {\n \"identity_providers\": [\n {\n \"id\": \"\",\n \"friendly_name\": \"\",\n \"auto_provision_users\": \"\",\n \"type\": \"\",\n \"saml_20\": {\n \"issuer\": \"\",\n \"settings\": [\n {\n \"key\": \"\",\n \"value\": {},\n \"type\": \"\"\n },\n {\n \"key\": \"\",\n \"value\": {},\n \"type\": \"\"\n }\n ],\n \"certificates\": [\n {\n \"id\": \"\",\n \"issuer\": \"\",\n \"thumbprint\": \"\",\n \"expiration_date\": \"\",\n \"is_valid\": \"\",\n \"links\": [\n {\n \"rel\": \"\",\n \"href\": \"\"\n },\n {\n \"rel\": \"\",\n \"href\": \"\"\n }\n ]\n },\n {\n \"id\": \"\",\n \"issuer\": \"\",\n \"thumbprint\": \"\",\n \"expiration_date\": \"\",\n \"is_valid\": \"\",\n \"links\": [\n {\n \"rel\": \"\",\n \"href\": \"\"\n },\n {\n \"rel\": \"\",\n \"href\": \"\"\n }\n ]\n }\n ],\n \"attribute_mappings\": [\n {\n \"required_attribute_id\": \"\",\n \"required_attribute_name\": \"\",\n \"required_attribute_friendly_name\": \"\",\n \"substitute_attribute_name\": \"\"\n },\n {\n \"required_attribute_id\": \"\",\n \"required_attribute_name\": \"\",\n \"required_attribute_friendly_name\": \"\",\n \"substitute_attribute_name\": \"\"\n }\n ]\n },\n \"links\": [\n {\n \"rel\": \"\",\n \"href\": \"\"\n },\n {\n \"rel\": \"\",\n \"href\": \"\"\n }\n ]\n },\n {\n \"id\": \"\",\n \"friendly_name\": \"\",\n \"auto_provision_users\": \"\",\n \"type\": \"\",\n \"saml_20\": {\n \"issuer\": \"\",\n \"settings\": [\n {\n \"key\": \"\",\n \"value\": {},\n \"type\": \"\"\n },\n {\n \"key\": \"\",\n \"value\": {},\n \"type\": \"\"\n }\n ],\n \"certificates\": [\n {\n \"id\": \"\",\n \"issuer\": \"\",\n \"thumbprint\": \"\",\n \"expiration_date\": \"\",\n \"is_valid\": \"\",\n \"links\": [\n {\n \"rel\": \"\",\n \"href\": \"\"\n },\n {\n \"rel\": \"\",\n \"href\": \"\"\n }\n ]\n },\n {\n \"id\": \"\",\n \"issuer\": \"\",\n \"thumbprint\": \"\",\n \"expiration_date\": \"\",\n \"is_valid\": \"\",\n \"links\": [\n {\n \"rel\": \"\",\n \"href\": \"\"\n },\n {\n \"rel\": \"\",\n \"href\": \"\"\n }\n ]\n }\n ],\n \"attribute_mappings\": [\n {\n \"required_attribute_id\": \"\",\n \"required_attribute_name\": \"\",\n \"required_attribute_friendly_name\": \"\",\n \"substitute_attribute_name\": \"\"\n },\n {\n \"required_attribute_id\": \"\",\n \"required_attribute_name\": \"\",\n \"required_attribute_friendly_name\": \"\",\n \"substitute_attribute_name\": \"\"\n }\n ]\n },\n \"links\": [\n {\n \"rel\": \"\",\n \"href\": \"\"\n },\n {\n \"rel\": \"\",\n \"href\": \"\"\n }\n ]\n }\n ]\n }\n ],\n \"links\": [\n {\n \"rel\": \"\",\n \"href\": \"\"\n },\n {\n \"rel\": \"\",\n \"href\": \"\"\n }\n ]\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } } ] }, { - "_postman_id": "d3c22c25-1830-47a8-90bc-bf55f9a7a474", - "name": "ReservedDomains", - "description": "Folder for ReservedDomains", + "name": "AccountSettingsImport", + "description": "Methods and objects to update account settings.", "item": [ { - "_postman_id": "2726aaa2-5880-43fe-9285-657534f1c381", - "name": "Returns the list of reserved domains for the organization.", + "id": "3a82a42b-f2de-4723-9b9a-ce1b9ba2e9c5", + "name": "Returns the details/metadata for Bulk Account Settings Import requests in the organization", "request": { + "name": "Returns the details and metadata for Bulk Account Settings Import requests in the organization.", + "description": { + "content": "Required scopes: account_read", + "type": "text/markdown" + }, "url": { - "raw": "https://{{hostenv}}/Management/v2/organizations/{{organizationId}}/reserved_domains", - "protocol": "https", - "auth": {}, - "host": [ - "{{hostenv}}" - ], "path": [ - "Management", "v2", "organizations", - "{{organizationId}}", - "reserved_domains" + ":organizationId", + "imports", + "account_settings" + ], + "host": [ + "{{baseUrl}}" ], + "query": [], "variable": [ { - "value": "{{organizationId}}", - "id": "organizationId" + "type": "any", + "value": "", + "key": "organizationId", + "disabled": false, + "description": { + "content": "(Required) The organization ID Guid", + "type": "text/plain" + } } ] }, - "method": "GET", "header": [ { "key": "Accept", - "value": "application/json", - "description": "" - }, - { - "key": "Content-Type", - "value": "application/json", - "description": "" - }, - { - "key": "Authorization", - "value": "Bearer {{accessToken}}", - "description": "" + "value": "application/json" } ], - "body": { - "mode": "raw", - "raw": "{}" - }, - "description": "Required scopes: domain_read" + "method": "GET", + "body": {}, + "auth": null }, - "response": [] - } - ] - }, - { - "_postman_id": "3531deb2-33c7-441b-9dc5-88db603a7356", - "name": "AccountProvisioning", - "description": "Folder for AccountProvisioning", - "item": [ + "response": [ + { + "id": "4c1eb085-2875-45d4-b308-447854b63300", + "name": "OK", + "originalRequest": { + "url": { + "path": [ + "v2", + "organizations", + ":organizationId", + "imports", + "account_settings" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "GET", + "body": {} + }, + "status": "OK", + "code": 200, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "[\n {\n \"created\": \"\",\n \"last_modified\": \"\",\n \"completed\": \"\",\n \"expires\": \"\",\n \"percent_completed\": \"\",\n \"number_processed_accounts\": \"\",\n \"number_unprocessed_accounts\": \"\",\n \"results\": [\n {\n \"id\": \"\",\n \"site_id\": \"\",\n \"url\": \"\",\n \"number_processed_accounts\": \"\",\n \"error_details\": {\n \"error\": \"\",\n \"error_description\": \"\"\n },\n \"processing_issues_by_account\": [\n {\n \"account_id\": \"\",\n \"account_name\": \"\",\n \"error\": \"\",\n \"error_key\": \"\",\n \"setting_key\": \"\"\n },\n {\n \"account_id\": \"\",\n \"account_name\": \"\",\n \"error\": \"\",\n \"error_key\": \"\",\n \"setting_key\": \"\"\n }\n ],\n \"number_unprocessed_accounts\": \"\"\n },\n {\n \"id\": \"\",\n \"site_id\": \"\",\n \"url\": \"\",\n \"number_processed_accounts\": \"\",\n \"error_details\": {\n \"error\": \"\",\n \"error_description\": \"\"\n },\n \"processing_issues_by_account\": [\n {\n \"account_id\": \"\",\n \"account_name\": \"\",\n \"error\": \"\",\n \"error_key\": \"\",\n \"setting_key\": \"\"\n },\n {\n \"account_id\": \"\",\n \"account_name\": \"\",\n \"error\": \"\",\n \"error_key\": \"\",\n \"setting_key\": \"\"\n }\n ],\n \"number_unprocessed_accounts\": \"\"\n }\n ],\n \"success\": \"\",\n \"skipped_settings_by_account\": {\n \"nostrudb10\": [\n \"\",\n \"\"\n ]\n },\n \"id\": \"\",\n \"organization_id\": \"\",\n \"status\": \"\",\n \"type\": \"\",\n \"requestor\": {\n \"id\": \"\",\n \"type\": \"\",\n \"name\": \"\",\n \"email\": \"\"\n }\n },\n {\n \"created\": \"\",\n \"last_modified\": \"\",\n \"completed\": \"\",\n \"expires\": \"\",\n \"percent_completed\": \"\",\n \"number_processed_accounts\": \"\",\n \"number_unprocessed_accounts\": \"\",\n \"results\": [\n {\n \"id\": \"\",\n \"site_id\": \"\",\n \"url\": \"\",\n \"number_processed_accounts\": \"\",\n \"error_details\": {\n \"error\": \"\",\n \"error_description\": \"\"\n },\n \"processing_issues_by_account\": [\n {\n \"account_id\": \"\",\n \"account_name\": \"\",\n \"error\": \"\",\n \"error_key\": \"\",\n \"setting_key\": \"\"\n },\n {\n \"account_id\": \"\",\n \"account_name\": \"\",\n \"error\": \"\",\n \"error_key\": \"\",\n \"setting_key\": \"\"\n }\n ],\n \"number_unprocessed_accounts\": \"\"\n },\n {\n \"id\": \"\",\n \"site_id\": \"\",\n \"url\": \"\",\n \"number_processed_accounts\": \"\",\n \"error_details\": {\n \"error\": \"\",\n \"error_description\": \"\"\n },\n \"processing_issues_by_account\": [\n {\n \"account_id\": \"\",\n \"account_name\": \"\",\n \"error\": \"\",\n \"error_key\": \"\",\n \"setting_key\": \"\"\n },\n {\n \"account_id\": \"\",\n \"account_name\": \"\",\n \"error\": \"\",\n \"error_key\": \"\",\n \"setting_key\": \"\"\n }\n ],\n \"number_unprocessed_accounts\": \"\"\n }\n ],\n \"success\": \"\",\n \"skipped_settings_by_account\": {\n \"Lorem7\": [\n \"\",\n \"\"\n ]\n },\n \"id\": \"\",\n \"organization_id\": \"\",\n \"status\": \"\",\n \"type\": \"\",\n \"requestor\": {\n \"id\": \"\",\n \"type\": \"\",\n \"name\": \"\",\n \"email\": \"\"\n }\n }\n]", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + }, { - "_postman_id": "d97d7f68-69e3-44f0-a86d-1b6f8e39c8fd", - "name": "Get all accounts in asset groups for the organization.", + "id": "c3d4b7d9-2f71-4515-97ab-5d8560646d44", + "name": "Creates a new account settings import request.", "request": { + "name": "Creates a new account settings import request.", + "description": { + "content": "Required scopes: account_write", + "type": "text/markdown" + }, "url": { - "raw": "https://{{hostenv}}/Management/v1/organizations/{{organizationId}}/assetGroups/accounts?compliant={{compliant}}", - "protocol": "https", - "auth": {}, - "host": [ - "{{hostenv}}" - ], "path": [ - "Management", - "v1", + "v2", "organizations", - "{{organizationId}}", - "assetGroups", - "accounts" + ":organizationId", + "imports", + "account_settings" ], - "query": [ - { - "key": "compliant", - "value": "{{compliant}}" - } + "host": [ + "{{baseUrl}}" ], + "query": [], "variable": [ { - "value": "{{organizationId}}", - "id": "organizationId" + "type": "any", + "value": "", + "key": "organizationId", + "disabled": false, + "description": { + "content": "(Required) The organization ID GUID.", + "type": "text/plain" + } } ] }, - "method": "GET", "header": [ - { - "key": "Accept", - "value": "application/json", - "description": "" - }, { "key": "Content-Type", - "value": "application/json", - "description": "" + "value": "multipart/form-data" }, { - "key": "Authorization", - "value": "Bearer {{accessToken}}", - "description": "" + "key": "Accept", + "value": "application/json" } ], + "method": "POST", "body": { - "mode": "raw", - "raw": "{}" + "mode": "formdata", + "formdata": [ + { + "description": { + "content": "(Required) CSV file.", + "type": "text/plain" + }, + "key": "file.csv", + "type": "file" + } + ] }, - "description": "Required scopes: asset_group_account_read" + "auth": null }, - "response": [] + "response": [ + { + "id": "1b91e123-4f4b-4208-bb3d-e176e6bb0e90", + "name": "OK", + "originalRequest": { + "url": { + "path": [ + "v2", + "organizations", + ":organizationId", + "imports", + "account_settings" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "multipart/form-data" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "POST", + "body": { + "mode": "formdata", + "formdata": [ + { + "description": { + "content": "(Required) CSV file.", + "type": "text/plain" + }, + "key": "file.csv", + "type": "file" + } + ] + } + }, + "status": "OK", + "code": 200, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"created\": \"\",\n \"last_modified\": \"\",\n \"completed\": \"\",\n \"expires\": \"\",\n \"percent_completed\": \"\",\n \"number_processed_accounts\": \"\",\n \"number_unprocessed_accounts\": \"\",\n \"results\": [\n {\n \"id\": \"\",\n \"site_id\": \"\",\n \"url\": \"\",\n \"number_processed_accounts\": \"\",\n \"error_details\": {\n \"error\": \"\",\n \"error_description\": \"\"\n },\n \"processing_issues_by_account\": [\n {\n \"account_id\": \"\",\n \"account_name\": \"\",\n \"error\": \"\",\n \"error_key\": \"\",\n \"setting_key\": \"\"\n },\n {\n \"account_id\": \"\",\n \"account_name\": \"\",\n \"error\": \"\",\n \"error_key\": \"\",\n \"setting_key\": \"\"\n }\n ],\n \"number_unprocessed_accounts\": \"\"\n },\n {\n \"id\": \"\",\n \"site_id\": \"\",\n \"url\": \"\",\n \"number_processed_accounts\": \"\",\n \"error_details\": {\n \"error\": \"\",\n \"error_description\": \"\"\n },\n \"processing_issues_by_account\": [\n {\n \"account_id\": \"\",\n \"account_name\": \"\",\n \"error\": \"\",\n \"error_key\": \"\",\n \"setting_key\": \"\"\n },\n {\n \"account_id\": \"\",\n \"account_name\": \"\",\n \"error\": \"\",\n \"error_key\": \"\",\n \"setting_key\": \"\"\n }\n ],\n \"number_unprocessed_accounts\": \"\"\n }\n ],\n \"success\": \"\",\n \"skipped_settings_by_account\": {\n \"et_35\": [\n \"\",\n \"\"\n ]\n },\n \"id\": \"\",\n \"organization_id\": \"\",\n \"status\": \"\",\n \"type\": \"\",\n \"requestor\": {\n \"id\": \"\",\n \"type\": \"\",\n \"name\": \"\",\n \"email\": \"\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } }, { - "_postman_id": "bb237906-2115-4042-bb8d-d5b8190960a4", - "name": "Clones an existing DocuSign account to a new DocuSign account.", + "id": "19cd97d5-3508-47b3-9d5f-95bdf13c3b96", + "name": "Returns the details/metadata for a Bulk Account Settings Import request", "request": { + "name": "Returns the details/metadata for a Bulk Account Settings Import request.", + "description": { + "content": "Required scopes: account_read", + "type": "text/markdown" + }, "url": { - "raw": "https://{{hostenv}}/Management/v1/organizations/{{organizationId}}/assetGroups/accountClone", - "protocol": "https", - "auth": {}, - "host": [ - "{{hostenv}}" - ], "path": [ - "Management", - "v1", + "v2", "organizations", - "{{organizationId}}", - "assetGroups", - "accountClone" + ":organizationId", + "imports", + "account_settings", + ":importId" + ], + "host": [ + "{{baseUrl}}" ], + "query": [], "variable": [ { - "value": "{{organizationId}}", - "id": "organizationId" + "type": "any", + "value": "", + "key": "organizationId", + "disabled": false, + "description": { + "content": "(Required) The organization ID Guid", + "type": "text/plain" + } + }, + { + "type": "any", + "value": "", + "key": "importId", + "disabled": false, + "description": { + "content": "(Required) The import ID GUID for the request.", + "type": "text/plain" + } } ] }, - "method": "POST", "header": [ { "key": "Accept", - "value": "application/json", - "description": "" - }, - { - "key": "Content-Type", - "value": "application/json", - "description": "" - }, - { - "key": "Authorization", - "value": "Bearer {{accessToken}}", - "description": "" + "value": "application/json" } ], - "body": { - "mode": "raw", - "raw": "{}" - }, - "description": "Currently this only clones eSign settings and asset group information.\n\nRequired scopes: asset_group_account_clone_write" + "method": "GET", + "body": {}, + "auth": null }, - "response": [] + "response": [ + { + "id": "11624694-03a6-4ea0-a72d-486308e07097", + "name": "OK", + "originalRequest": { + "url": { + "path": [ + "v2", + "organizations", + ":organizationId", + "imports", + "account_settings", + ":importId" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "GET", + "body": {} + }, + "status": "OK", + "code": 200, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"created\": \"\",\n \"last_modified\": \"\",\n \"completed\": \"\",\n \"expires\": \"\",\n \"percent_completed\": \"\",\n \"number_processed_accounts\": \"\",\n \"number_unprocessed_accounts\": \"\",\n \"results\": [\n {\n \"id\": \"\",\n \"site_id\": \"\",\n \"url\": \"\",\n \"number_processed_accounts\": \"\",\n \"error_details\": {\n \"error\": \"\",\n \"error_description\": \"\"\n },\n \"processing_issues_by_account\": [\n {\n \"account_id\": \"\",\n \"account_name\": \"\",\n \"error\": \"\",\n \"error_key\": \"\",\n \"setting_key\": \"\"\n },\n {\n \"account_id\": \"\",\n \"account_name\": \"\",\n \"error\": \"\",\n \"error_key\": \"\",\n \"setting_key\": \"\"\n }\n ],\n \"number_unprocessed_accounts\": \"\"\n },\n {\n \"id\": \"\",\n \"site_id\": \"\",\n \"url\": \"\",\n \"number_processed_accounts\": \"\",\n \"error_details\": {\n \"error\": \"\",\n \"error_description\": \"\"\n },\n \"processing_issues_by_account\": [\n {\n \"account_id\": \"\",\n \"account_name\": \"\",\n \"error\": \"\",\n \"error_key\": \"\",\n \"setting_key\": \"\"\n },\n {\n \"account_id\": \"\",\n \"account_name\": \"\",\n \"error\": \"\",\n \"error_key\": \"\",\n \"setting_key\": \"\"\n }\n ],\n \"number_unprocessed_accounts\": \"\"\n }\n ],\n \"success\": \"\",\n \"skipped_settings_by_account\": {\n \"et_35\": [\n \"\",\n \"\"\n ]\n },\n \"id\": \"\",\n \"organization_id\": \"\",\n \"status\": \"\",\n \"type\": \"\",\n \"requestor\": {\n \"id\": \"\",\n \"type\": \"\",\n \"name\": \"\",\n \"email\": \"\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } }, { - "_postman_id": "a97c7ebf-63a0-4467-9e8c-abc6341fbede", - "name": "Gets all asset group account clone(s) for an organization id.", + "id": "f778a54d-f8a7-4c00-967b-0e1b9fc30a40", + "name": "Deletes a Bulk Account Settings Import request", "request": { + "name": "Deletes a Bulk Account Settings Import request.", + "description": { + "content": "Required scopes: account_write", + "type": "text/markdown" + }, "url": { - "raw": "https://{{hostenv}}/Management/v1/organizations/{{organizationId}}/assetGroups/accountClones?since_updated_date={{since_updated_date}}&include_details={{include_details}}", - "protocol": "https", - "auth": {}, - "host": [ - "{{hostenv}}" - ], "path": [ - "Management", - "v1", + "v2", "organizations", - "{{organizationId}}", - "assetGroups", - "accountClones" + ":organizationId", + "imports", + "account_settings", + ":importId" ], - "query": [ - { - "key": "since_updated_date", - "value": "{{since_updated_date}}" - }, - { - "key": "include_details", - "value": "{{include_details}}" - } + "host": [ + "{{baseUrl}}" ], + "query": [], "variable": [ { - "value": "{{organizationId}}", - "id": "organizationId" + "type": "any", + "value": "", + "key": "organizationId", + "disabled": false, + "description": { + "content": "(Required) The organization ID Guid", + "type": "text/plain" + } + }, + { + "type": "any", + "value": "", + "key": "importId", + "disabled": false, + "description": { + "content": "(Required) The import ID GUID for the request.", + "type": "text/plain" + } } ] }, - "method": "GET", "header": [ { "key": "Accept", - "value": "application/json", - "description": "" - }, - { - "key": "Content-Type", - "value": "application/json", - "description": "" - }, - { - "key": "Authorization", - "value": "Bearer {{accessToken}}", - "description": "" + "value": "application/json" } ], - "body": { - "mode": "raw", - "raw": "{}" - }, - "description": "Required scopes: asset_group_account_clone_read" + "method": "DELETE", + "body": {}, + "auth": null }, - "response": [] - }, + "response": [ + { + "id": "8c656077-dc94-4109-bf1e-aec396284280", + "name": "OK", + "originalRequest": { + "url": { + "path": [ + "v2", + "organizations", + ":organizationId", + "imports", + "account_settings", + ":importId" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "DELETE", + "body": {} + }, + "status": "OK", + "code": 200, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + } + ] + }, + { + "name": "SingleAccountUserImport", + "description": "Methods to import users.", + "item": [ { - "_postman_id": "d54750ad-ca95-443e-b7eb-9ddebfe4d9e4", - "name": "Gets an asset group account clone by the asset group work id.", + "id": "c92aebd8-5b57-42a9-99dc-ebf36172f5dc", + "name": "Import request for adding user to a single account within the organization. Allows upload of user information without requiring an AccountId column", "request": { + "name": "Import request for adding a user to a single account within the organization.", + "description": { + "content": "Required scopes: user_write", + "type": "text/markdown" + }, "url": { - "raw": "https://{{hostenv}}/Management/v1/organizations/{{organizationId}}/assetGroups/{{assetGroupId}}/accountClones/{{assetGroupWorkId}}?include_details={{include_details}}", - "protocol": "https", - "auth": {}, - "host": [ - "{{hostenv}}" - ], "path": [ - "Management", - "v1", + "v2", "organizations", - "{{organizationId}}", - "assetGroups", - "{{assetGroupId}}", - "accountClones", - "{{assetGroupWorkId}}" + ":organizationId", + "accounts", + ":accountId", + "imports", + "bulk_users", + "add" ], - "query": [ - { - "key": "include_details", - "value": "{{include_details}}" - } + "host": [ + "{{baseUrl}}" ], + "query": [], "variable": [ { - "value": "{{organizationId}}", - "id": "organizationId" + "type": "any", + "value": "", + "key": "organizationId", + "disabled": false, + "description": { + "content": "(Required) The organization ID Guid", + "type": "text/plain" + } }, { - "value": "{{assetGroupId}}", - "id": "assetGroupId" - }, - { - "value": "{{assetGroupWorkId}}", - "id": "assetGroupWorkId" + "type": "any", + "value": "", + "key": "accountId", + "disabled": false, + "description": { + "content": "(Required) The account ID Guid", + "type": "text/plain" + } } ] }, - "method": "GET", "header": [ - { - "key": "Accept", - "value": "application/json", - "description": "" - }, { "key": "Content-Type", - "value": "application/json", - "description": "" + "value": "multipart/form-data" }, { - "key": "Authorization", - "value": "Bearer {{accessToken}}", - "description": "" + "key": "Accept", + "value": "application/json" } ], + "method": "POST", "body": { - "mode": "raw", - "raw": "{}" + "mode": "formdata", + "formdata": [ + { + "description": { + "content": "(Required) CSV file.", + "type": "text/plain" + }, + "key": "file.csv", + "type": "file" + } + ] }, - "description": "Required scopes: asset_group_account_clone_read" + "auth": null }, - "response": [] - } - ] - }, - { - "_postman_id": "e6903c7e-f951-40b4-9518-0fb4c11a77c5", - "name": "Authentication", - "description": "Folder for Authentication", - "item": [ - { - "_postman_id": "2fc5a701-9668-481d-88ba-38bbfd9fbf0e", - "name": "01 Authorize Code Grant Access Token", - "event": [ + "response": [ { - "listen": "test", - "script": { - "type": "text/javascript", - "exec": "var jsonData = JSON.parse(responseBody);\npostman.setEnvironmentVariable(\"accessToken\", jsonData.access_token);\nvar jsonData = JSON.parse(responseBody);\npostman.setEnvironmentVariable(\"refreshToken\", jsonData.refresh_token);" - } - } - ], - "request": { - "url": "https://{{hostenv}}/oauth/token", - "method": "POST", - "header": [ - { - "key": "Authorization", - "value": "Basic {{encodedKeys}}", - "description": "" - } - ], - "body": { - "mode": "urlencoded", - "urlencoded": [ - { - "key": "code", - "value": "{{codeFromUrl}}" + "id": "71f6cdbc-02a3-4a66-a73c-8a67c5b6c657", + "name": "OK", + "originalRequest": { + "url": { + "path": [ + "v2", + "organizations", + ":organizationId", + "accounts", + ":accountId", + "imports", + "bulk_users", + "add" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] }, + "header": [ + { + "key": "Content-Type", + "value": "multipart/form-data" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "POST", + "body": { + "mode": "formdata", + "formdata": [ + { + "description": { + "content": "(Required) CSV file.", + "type": "text/plain" + }, + "key": "file.csv", + "type": "file" + } + ] + } + }, + "status": "OK", + "code": 200, + "header": [ { - "key": "grant_type", - "value": "authorization_code" + "key": "Content-Type", + "value": "application/json" } - ] + ], + "body": "{\n \"id\": \"\",\n \"type\": \"\",\n \"requestor\": {\n \"name\": \"\",\n \"id\": \"\",\n \"type\": \"\",\n \"email\": \"\"\n },\n \"created\": \"\",\n \"last_modified\": \"\",\n \"status\": \"\",\n \"user_count\": \"\",\n \"processed_user_count\": \"\",\n \"added_user_count\": \"\",\n \"updated_user_count\": \"\",\n \"closed_user_count\": \"\",\n \"no_action_required_user_count\": \"\",\n \"error_count\": \"\",\n \"warning_count\": \"\",\n \"invalid_column_headers\": \"\",\n \"imports_not_found_or_not_available_for_accounts\": \"\",\n \"imports_failed_for_accounts\": \"\",\n \"imports_timed_out_for_accounts\": \"\",\n \"imports_not_found_or_not_available_for_sites\": \"\",\n \"imports_failed_for_sites\": \"\",\n \"imports_timed_out_for_sites\": \"\",\n \"file_level_error_rollups\": [\n {\n \"error_type\": \"\",\n \"count\": \"\"\n },\n {\n \"error_type\": \"\",\n \"count\": \"\"\n }\n ],\n \"user_level_error_rollups\": [\n {\n \"error_type\": \"\",\n \"count\": \"\"\n },\n {\n \"error_type\": \"\",\n \"count\": \"\"\n }\n ],\n \"user_level_warning_rollups\": [\n {\n \"warning_type\": \"\",\n \"count\": \"\"\n },\n {\n \"warning_type\": \"\",\n \"count\": \"\"\n }\n ],\n \"has_csv_results\": \"\",\n \"results_uri\": \"\"\n}", + "cookie": [], + "_postman_previewlanguage": "json" } - }, - "response": [] + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } }, { - "_postman_id": "ae305c11-98b9-46e3-83b7-8d2fe8a718af", - "name": "02 JWT Access Token", - "event": [ - { - "listen": "test", - "script": { - "type": "text/javascript", - "exec": "var jsonData = JSON.parse(responseBody);\npostman.setEnvironmentVariable(\"accessToken\", jsonData.access_token);\nvar jsonData = JSON.parse(responseBody);\npostman.setEnvironmentVariable(\"refreshToken\", jsonData.refresh_token);" - } - } - ], + "id": "1c942220-b1fb-43ae-b963-24f7ba20a861", + "name": "Import request for updating users for a single account within the organization. Allows upload of user information without requiring an AccountId column", "request": { - "url": "https://{{hostenv}}/oauth/token", - "method": "POST", - "header": [ - { - "key": "Authorization", - "value": "Basic {{encodedKeys}}", - "description": "" - } - ], - "body": { - "mode": "urlencoded", - "urlencoded": [ + "name": "Import request for updating users for a single account\nwithin the organization.", + "description": { + "content": "Required scopes: user_write", + "type": "text/markdown" + }, + "url": { + "path": [ + "v2", + "organizations", + ":organizationId", + "accounts", + ":accountId", + "imports", + "bulk_users", + "update" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [ { - "key": "assertion", - "value": "{{assertionHere}}" + "type": "any", + "value": "", + "key": "organizationId", + "disabled": false, + "description": { + "content": "(Required) The organization ID Guid", + "type": "text/plain" + } }, { - "key": "grant_type", - "value": "urn:ietf:params:oauth:grant-type:jwt-bearer" + "type": "any", + "value": "", + "key": "accountId", + "disabled": false, + "description": { + "content": "(Required) The account ID Guid", + "type": "text/plain" + } } ] - } - }, - "response": [] - }, - { - "_postman_id": "edbaa935-6153-4566-9782-06bf7eabe499", - "name": "03 Refresh Access Token", - "event": [ - { - "listen": "test", - "script": { - "type": "text/javascript", - "exec": "var jsonData = JSON.parse(responseBody);\npostman.setEnvironmentVariable(\"accessToken\", jsonData.access_token);\nvar jsonData = JSON.parse(responseBody);\npostman.setEnvironmentVariable(\"refreshToken\", jsonData.refresh_token);" - } - } - ], - "request": { - "url": "https://{{hostenv}}/oauth/token", - "method": "POST", + }, "header": [ { - "key": "Authorization", - "value": "Basic {{encodedKeys}}", - "description": "" + "key": "Content-Type", + "value": "multipart/form-data" + }, + { + "key": "Accept", + "value": "application/json" } ], + "method": "POST", "body": { - "mode": "urlencoded", - "urlencoded": [ + "mode": "formdata", + "formdata": [ { - "key": "refresh_token", - "value": "{{refreshToken}}" - }, - { - "key": "grant_type", - "value": "refresh_token" + "description": { + "content": "(Required) CSV file.", + "type": "text/plain" + }, + "key": "file.csv", + "type": "file" } ] - } + }, + "auth": null }, - "response": [] - }, - { - "_postman_id": "2bd3ee9e-3f1d-4de7-bb35-4ace8d433d3c", - "name": "04 Get User Info", - "event": [ + "response": [ { - "listen": "test", - "script": { - "type": "text/javascript", - "exec": "var jsonData = JSON.parse(responseBody);\nvar accounts = jsonData.accounts;\nif (jsonData.hasOwnProperty(\"sub\")) { \n postman.setEnvironmentVariable(\"userId\", jsonData.sub); \n} \n\nfor (var i=0; i< accounts.length; i++) { \n if (accounts[i].hasOwnProperty(\"is_default\")) { \n if (accounts[i].is_default === true) { \n postman.setEnvironmentVariable(\"accountId\", accounts[i].account_id); \n postman.setEnvironmentVariable(\"baseUrl\", accounts[i].base_uri + \"/restapi/\"); \n postman.setEnvironmentVariable(\"accountName\", accounts[i].account_name); \n } \n } \n} \n" - } - } + "id": "22159bc5-15ec-48b9-a75a-7b214236a267", + "name": "OK", + "originalRequest": { + "url": { + "path": [ + "v2", + "organizations", + ":organizationId", + "accounts", + ":accountId", + "imports", + "bulk_users", + "update" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "multipart/form-data" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "POST", + "body": { + "mode": "formdata", + "formdata": [ + { + "description": { + "content": "(Required) CSV file.", + "type": "text/plain" + }, + "key": "file.csv", + "type": "file" + } + ] + } + }, + "status": "OK", + "code": 200, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"id\": \"\",\n \"type\": \"\",\n \"requestor\": {\n \"name\": \"\",\n \"id\": \"\",\n \"type\": \"\",\n \"email\": \"\"\n },\n \"created\": \"\",\n \"last_modified\": \"\",\n \"status\": \"\",\n \"user_count\": \"\",\n \"processed_user_count\": \"\",\n \"added_user_count\": \"\",\n \"updated_user_count\": \"\",\n \"closed_user_count\": \"\",\n \"no_action_required_user_count\": \"\",\n \"error_count\": \"\",\n \"warning_count\": \"\",\n \"invalid_column_headers\": \"\",\n \"imports_not_found_or_not_available_for_accounts\": \"\",\n \"imports_failed_for_accounts\": \"\",\n \"imports_timed_out_for_accounts\": \"\",\n \"imports_not_found_or_not_available_for_sites\": \"\",\n \"imports_failed_for_sites\": \"\",\n \"imports_timed_out_for_sites\": \"\",\n \"file_level_error_rollups\": [\n {\n \"error_type\": \"\",\n \"count\": \"\"\n },\n {\n \"error_type\": \"\",\n \"count\": \"\"\n }\n ],\n \"user_level_error_rollups\": [\n {\n \"error_type\": \"\",\n \"count\": \"\"\n },\n {\n \"error_type\": \"\",\n \"count\": \"\"\n }\n ],\n \"user_level_warning_rollups\": [\n {\n \"warning_type\": \"\",\n \"count\": \"\"\n },\n {\n \"warning_type\": \"\",\n \"count\": \"\"\n }\n ],\n \"has_csv_results\": \"\",\n \"results_uri\": \"\"\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + } + ] + }, + { + "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/).", + "item": [ + { + "id": "efbbadb0-eb65-40e3-a4be-2d6d262b0ec7", + "name": "Redacts membership data for users with memberships in an account.", "request": { - "url": "https://{{hostenv}}/oauth/userinfo", - "method": "Get", + "name": "Deletes membership data for a user on an account.", + "description": { + "content": "Required scopes: user_data_redact", + "type": "text/markdown" + }, + "url": { + "path": [ + "v2", + "data_redaction", + "accounts", + ":accountId", + "user" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [ + { + "type": "any", + "value": "", + "key": "accountId", + "disabled": false, + "description": { + "content": "(Required) The ID of the account from which to delete the user's data.\n", + "type": "text/plain" + } + } + ] + }, "header": [ { - "key": "Authorization", - "value": "Bearer {{accessToken}}", - "description": "" + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" } ], + "method": "POST", "body": { "mode": "raw", - "raw": "" + "raw": "{\n \"user_id\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "auth": null + }, + "response": [ + { + "id": "6e556cfa-16fb-4b2f-a9be-84bc1b9295fa", + "name": "OK", + "originalRequest": { + "url": { + "path": [ + "v2", + "data_redaction", + "accounts", + ":accountId", + "user" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"user_id\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "OK", + "code": 200, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"user_id\": \"\",\n \"status\": \"already_redacted\",\n \"membership_results\": [\n {\n \"account_id\": \"\",\n \"status\": \"pending\"\n },\n {\n \"account_id\": \"\",\n \"status\": \"success\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + }, + { + "id": "ccc53a3f-efad-4ca5-9985-b42d8215593e", + "name": "Redacts membership and user data for users in an organization.", + "request": { + "name": "Deletes data for one or more of a user's account memberships.", + "description": { + "content": "Required scopes: user_data_redact", + "type": "text/markdown" + }, + "url": { + "path": [ + "v2", + "data_redaction", + "organizations", + ":organizationId", + "user" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [ + { + "type": "any", + "value": "", + "key": "organizationId", + "disabled": false, + "description": { + "content": "(Required) The organization ID Guid", + "type": "text/plain" + } + } + ] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"user_id\": \"\",\n \"memberships\": [\n {\n \"account_id\": \"\"\n },\n {\n \"account_id\": \"\"\n }\n ]\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "auth": null }, - "response": [] + "response": [ + { + "id": "cf52a3e8-118e-4cfb-9735-0bab9344d7e5", + "name": "OK", + "originalRequest": { + "url": { + "path": [ + "v2", + "data_redaction", + "organizations", + ":organizationId", + "user" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"user_id\": \"\",\n \"memberships\": [\n {\n \"account_id\": \"\"\n },\n {\n \"account_id\": \"\"\n }\n ]\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "OK", + "code": 200, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"user_id\": \"\",\n \"status\": \"already_redacted\",\n \"membership_results\": [\n {\n \"account_id\": \"\",\n \"status\": \"pending\"\n },\n {\n \"account_id\": \"\",\n \"status\": \"success\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } } ] }, { - "_postman_id": "c948f746-ee39-4a95-b6ac-abb394ffa4e6", - "name": "Returns the list of permission profiles in an account.", - "request": { - "url": { - "raw": "https://{{hostenv}}/Management/v2/organizations/{{organizationId}}/accounts/{{accountId}}/permissions", - "protocol": "https", - "auth": {}, - "host": [ - "{{hostenv}}" - ], - "path": [ - "Management", - "v2", - "organizations", - "{{organizationId}}", - "accounts", - "{{accountId}}", - "permissions" - ], - "variable": [ - { - "value": "{{organizationId}}", - "id": "organizationId" + "name": "AccountCloning", + "description": "Methods to clone accounts.", + "item": [ + { + "id": "51fe310e-d49a-42dc-bece-343f72743c73", + "name": "Get asset group accounts for an organization.", + "request": { + "name": "Get asset group accounts for an organization.", + "description": { + "content": "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/).", + "type": "text/plain" }, + "url": { + "path": [ + "v2", + "organizations", + ":organizationId", + "assetGroups", + "accounts" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": true, + "description": { + "content": "When **true,** only compliant accounts are returned and account responses do not include the `compliant` field. The default value is **false.**", + "type": "text/plain" + }, + "key": "compliant", + "value": "" + } + ], + "variable": [ + { + "type": "any", + "value": "", + "key": "organizationId", + "disabled": false, + "description": { + "content": "(Required) The organization's GUID.\n", + "type": "text/plain" + } + } + ] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "GET", + "body": {}, + "auth": null + }, + "response": [ { - "value": "{{accountId}}", - "id": "accountId" + "id": "3bdbb6ab-1843-4ee1-b43e-61898d568409", + "name": "OK", + "originalRequest": { + "url": { + "path": [ + "v2", + "organizations", + ":organizationId", + "assetGroups", + "accounts" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": true, + "description": { + "content": "When **true,** only compliant accounts are returned and account responses do not include the `compliant` field. The default value is **false.**", + "type": "text/plain" + }, + "key": "compliant", + "value": "" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "GET", + "body": {} + }, + "status": "OK", + "code": 200, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"assetGroupAccounts\": [\n {\n \"assetGroupId\": \"\",\n \"assetGroupName\": \"\",\n \"accountId\": \"\",\n \"accountName\": \"\",\n \"externalAccountId\": \"\",\n \"compliant\": \"\",\n \"siteId\": \"\",\n \"siteName\": \"\"\n },\n {\n \"assetGroupId\": \"\",\n \"assetGroupName\": \"\",\n \"accountId\": \"\",\n \"accountName\": \"\",\n \"externalAccountId\": \"\",\n \"compliant\": \"\",\n \"siteId\": \"\",\n \"siteName\": \"\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" } - ] - }, - "method": "GET", - "header": [ - { - "key": "Accept", - "value": "application/json", - "description": "" - }, - { - "key": "Content-Type", - "value": "application/json", - "description": "" - }, - { - "key": "Authorization", - "value": "Bearer {{accessToken}}", - "description": "" + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true } - ], - "body": { - "mode": "raw", - "raw": "{}" }, - "description": "Required scopes: permission_read" - }, - "response": [] - }, - { - "_postman_id": "d5161bbe-ca23-405e-9fa4-918bd4c87f76", - "name": "Returns the list of groups in an account.", - "request": { - "url": { - "raw": "https://{{hostenv}}/Management/v2/organizations/{{organizationId}}/accounts/{{accountId}}/groups?start={{start}}&take={{take}}&end={{end}}", - "protocol": "https", - "auth": {}, - "host": [ - "{{hostenv}}" - ], - "path": [ - "Management", - "v2", - "organizations", - "{{organizationId}}", - "accounts", - "{{accountId}}", - "groups" - ], - "query": [ - { - "key": "start", - "value": "{{start}}" + { + "id": "93c68678-b1f3-47e7-9e44-f059f136dd62", + "name": "Clone an existing Docusign account.", + "request": { + "name": "Clone an existing Docusign account.", + "description": { + "content": "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/).", + "type": "text/plain" }, - { - "key": "take", - "value": "{{take}}" + "url": { + "path": [ + "v2", + "organizations", + ":organizationId", + "assetGroups", + "accountClone" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [ + { + "type": "any", + "value": "", + "key": "organizationId", + "disabled": false, + "description": { + "content": "(Required) The organization's GUID.\n", + "type": "text/plain" + } + } + ] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"sourceAccount\": {\n \"id\": \"\"\n },\n \"targetAccount\": {\n \"id\": \"\",\n \"name\": \"\",\n \"region\": \"\",\n \"countryCode\": \"\",\n \"site\": \"\",\n \"admin\": {\n \"email\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"locale\": \"pl\"\n }\n },\n \"cloneProcessingFailureDetails\": {}\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } }, + "auth": null + }, + "response": [ { - "key": "end", - "value": "{{end}}" + "id": "1f234c6e-e5a3-4278-97cf-94f13f4fc9eb", + "name": "OK", + "originalRequest": { + "url": { + "path": [ + "v2", + "organizations", + ":organizationId", + "assetGroups", + "accountClone" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"sourceAccount\": {\n \"id\": \"\"\n },\n \"targetAccount\": {\n \"id\": \"\",\n \"name\": \"\",\n \"region\": \"\",\n \"countryCode\": \"\",\n \"site\": \"\",\n \"admin\": {\n \"email\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"locale\": \"pl\"\n }\n },\n \"cloneProcessingFailureDetails\": {}\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "OK", + "code": 200, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"sourceAccount\": {\n \"id\": \"\",\n \"externalAccountId\": \"\",\n \"site\": \"\",\n \"name\": \"\"\n },\n \"targetAccount\": {\n \"id\": \"\",\n \"name\": \"\",\n \"region\": \"\",\n \"countryCode\": \"\",\n \"site\": \"\",\n \"admin\": {\n \"email\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"locale\": \"es\"\n }\n },\n \"assetGroupWorkId\": \"\",\n \"assetGroupId\": \"\",\n \"assetGroupWorkType\": \"AccountAssetCreate\",\n \"status\": \"Completed\",\n \"cloneRequestId\": \"\",\n \"orderId\": \"\",\n \"attempts\": \"\",\n \"createdDate\": \"\",\n \"createdByName\": \"\",\n \"createdByEmail\": \"\",\n \"message\": \"\",\n \"cloneProcessingFailureDetails\": {\n \"error\": \"\",\n \"errorDescription\": \"\",\n \"isSystemError\": \"\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" } ], - "variable": [ - { - "value": "{{organizationId}}", - "id": "organizationId" + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } + }, + { + "id": "d1a0324e-ba9f-4f84-b7f5-8ac65859b86d", + "name": "Gets all asset group account clones for an organization.", + "request": { + "name": "Gets all asset group account clones for an organization.", + "description": { + "content": "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`.", + "type": "text/plain" + }, + "url": { + "path": [ + "v2", + "organizations", + ":organizationId", + "assetGroups", + "accountClones" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": true, + "description": { + "content": "Use this parameter to retrieve only account clones that were created on or after a specified date.", + "type": "text/plain" + }, + "key": "since_updated_date", + "value": "" + }, + { + "disabled": true, + "description": { + "content": "When **true,** include additional details for the asset group account clones. The default value is **false.**", + "type": "text/plain" + }, + "key": "include_details", + "value": "" + } + ], + "variable": [ + { + "type": "any", + "value": "", + "key": "organizationId", + "disabled": false, + "description": { + "content": "(Required) The organization's GUID.\n", + "type": "text/plain" + } + } + ] }, + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "GET", + "body": {}, + "auth": null + }, + "response": [ { - "value": "{{accountId}}", - "id": "accountId" + "id": "bbed32fe-9932-411d-8302-afcd5ae68bea", + "name": "OK", + "originalRequest": { + "url": { + "path": [ + "v2", + "organizations", + ":organizationId", + "assetGroups", + "accountClones" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": true, + "description": { + "content": "Use this parameter to retrieve only account clones that were created on or after a specified date.", + "type": "text/plain" + }, + "key": "since_updated_date", + "value": "" + }, + { + "disabled": true, + "description": { + "content": "When **true,** include additional details for the asset group account clones. The default value is **false.**", + "type": "text/plain" + }, + "key": "include_details", + "value": "" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "GET", + "body": {} + }, + "status": "OK", + "code": 200, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"assetGroupWorks\": [\n {\n \"sourceAccount\": {\n \"id\": \"\",\n \"externalAccountId\": \"\",\n \"site\": \"\",\n \"name\": \"\"\n },\n \"targetAccount\": {\n \"id\": \"\",\n \"name\": \"\",\n \"region\": \"\",\n \"countryCode\": \"\",\n \"site\": \"\",\n \"admin\": {\n \"email\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"locale\": \"en\"\n }\n },\n \"assetGroupWorkId\": \"\",\n \"assetGroupId\": \"\",\n \"assetGroupWorkType\": \"AccountAssetClone\",\n \"status\": \"PermanentFailure\",\n \"cloneRequestId\": \"\",\n \"orderId\": \"\",\n \"attempts\": \"\",\n \"createdDate\": \"\",\n \"createdByName\": \"\",\n \"createdByEmail\": \"\",\n \"message\": \"\",\n \"cloneProcessingFailureDetails\": {\n \"error\": \"\",\n \"errorDescription\": \"\",\n \"isSystemError\": \"\"\n }\n },\n {\n \"sourceAccount\": {\n \"id\": \"\",\n \"externalAccountId\": \"\",\n \"site\": \"\",\n \"name\": \"\"\n },\n \"targetAccount\": {\n \"id\": \"\",\n \"name\": \"\",\n \"region\": \"\",\n \"countryCode\": \"\",\n \"site\": \"\",\n \"admin\": {\n \"email\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"locale\": \"pt\"\n }\n },\n \"assetGroupWorkId\": \"\",\n \"assetGroupId\": \"\",\n \"assetGroupWorkType\": \"SubscriptionSync\",\n \"status\": \"Canceled\",\n \"cloneRequestId\": \"\",\n \"orderId\": \"\",\n \"attempts\": \"\",\n \"createdDate\": \"\",\n \"createdByName\": \"\",\n \"createdByEmail\": \"\",\n \"message\": \"\",\n \"cloneProcessingFailureDetails\": {\n \"error\": \"\",\n \"errorDescription\": \"\",\n \"isSystemError\": \"\"\n }\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" } - ] + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } }, - "method": "GET", - "header": [ - { - "key": "Accept", - "value": "application/json", - "description": "" - }, - { - "key": "Content-Type", - "value": "application/json", - "description": "" + { + "id": "8f04c5a2-5153-4e5c-bbf4-0946fd7f8eb4", + "name": "Gets information about a single cloned account.", + "request": { + "name": "Gets information about a single cloned account.", + "description": { + "content": "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`.", + "type": "text/plain" + }, + "url": { + "path": [ + "v2", + "organizations", + ":organizationId", + "assetGroups", + ":assetGroupId", + "accountClones", + ":assetGroupWorkId" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": true, + "description": { + "content": "When **true,** include additional details about the cloned account. The default value is **false.**", + "type": "text/plain" + }, + "key": "include_details", + "value": "" + } + ], + "variable": [ + { + "type": "any", + "value": "", + "key": "organizationId", + "disabled": false, + "description": { + "content": "(Required) The organization's GUID.\n", + "type": "text/plain" + } + }, + { + "type": "any", + "value": "", + "key": "assetGroupId", + "disabled": false, + "description": { + "content": "(Required) The ID of the asset group.", + "type": "text/plain" + } + }, + { + "type": "any", + "value": "", + "key": "assetGroupWorkId", + "disabled": false, + "description": { + "content": "(Required) The GUID representing the asset group account clone ID.", + "type": "text/plain" + } + } + ] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "GET", + "body": {}, + "auth": null }, - { - "key": "Authorization", - "value": "Bearer {{accessToken}}", - "description": "" + "response": [ + { + "id": "36941d15-3abf-46c2-973e-9dd3a5c55afc", + "name": "OK", + "originalRequest": { + "url": { + "path": [ + "v2", + "organizations", + ":organizationId", + "assetGroups", + ":assetGroupId", + "accountClones", + ":assetGroupWorkId" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": true, + "description": { + "content": "When **true,** include additional details about the cloned account. The default value is **false.**", + "type": "text/plain" + }, + "key": "include_details", + "value": "" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "GET", + "body": {} + }, + "status": "OK", + "code": 200, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"sourceAccount\": {\n \"id\": \"\",\n \"externalAccountId\": \"\",\n \"site\": \"\",\n \"name\": \"\"\n },\n \"targetAccount\": {\n \"id\": \"\",\n \"name\": \"\",\n \"region\": \"\",\n \"countryCode\": \"\",\n \"site\": \"\",\n \"admin\": {\n \"email\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"locale\": \"es\"\n }\n },\n \"assetGroupWorkId\": \"\",\n \"assetGroupId\": \"\",\n \"assetGroupWorkType\": \"AccountAssetCreate\",\n \"status\": \"Completed\",\n \"cloneRequestId\": \"\",\n \"orderId\": \"\",\n \"attempts\": \"\",\n \"createdDate\": \"\",\n \"createdByName\": \"\",\n \"createdByEmail\": \"\",\n \"message\": \"\",\n \"cloneProcessingFailureDetails\": {\n \"error\": \"\",\n \"errorDescription\": \"\",\n \"isSystemError\": \"\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true } - ], - "body": { - "mode": "raw", - "raw": "{}" - }, - "description": "Required scopes: group_read" - }, - "response": [] + } + ] }, { - "_postman_id": "f7c6b50a-7ffa-4695-9c22-dfede9a068c6", - "name": "Updates a user.", - "request": { - "url": { - "raw": "https://{{hostenv}}/Management/v2/organizations/{{organizationId}}/users/profiles", - "protocol": "https", - "auth": {}, - "host": [ - "{{hostenv}}" - ], - "path": [ - "Management", - "v2", - "organizations", - "{{organizationId}}", - "users", - "profiles" - ], - "variable": [ + "name": "AccountCreation", + "description": "Methods to create accounts.", + "item": [ + { + "id": "548b74e8-ae37-4b4b-907c-8a34254fe200", + "name": "Get information about plan items within an organization.", + "request": { + "name": "Get information about plan items within an organization.", + "description": { + "content": "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", + "type": "text/plain" + }, + "url": { + "path": [ + "v2", + "organizations", + ":organizationId", + "planItems" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [ + { + "type": "any", + "value": "", + "key": "organizationId", + "disabled": false, + "description": { + "content": "(Required) The organization's GUID.\n", + "type": "text/plain" + } + } + ] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "GET", + "body": {}, + "auth": null + }, + "response": [ { - "value": "{{organizationId}}", - "id": "organizationId" + "id": "2bf0e1e4-1fb4-4ffa-be3f-a253fc66966b", + "name": "OK", + "originalRequest": { + "url": { + "path": [ + "v2", + "organizations", + ":organizationId", + "planItems" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "GET", + "body": {} + }, + "status": "OK", + "code": 200, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "[\n {\n \"plan_id\": \"\",\n \"plan_name\": \"\",\n \"associated_accounts_count\": \"\",\n \"asset_group_name\": \"\",\n \"asset_group_id\": \"\",\n \"subscription_name\": \"\",\n \"subscription_id\": \"\",\n \"modules\": [\n {\n \"plan_item_id\": \"\",\n \"plan_item_name\": \"\",\n \"plan_item_description\": \"\",\n \"plan_item_internal_id\": \"\"\n },\n {\n \"plan_item_id\": \"\",\n \"plan_item_name\": \"\",\n \"plan_item_description\": \"\",\n \"plan_item_internal_id\": \"\"\n }\n ]\n },\n {\n \"plan_id\": \"\",\n \"plan_name\": \"\",\n \"associated_accounts_count\": \"\",\n \"asset_group_name\": \"\",\n \"asset_group_id\": \"\",\n \"subscription_name\": \"\",\n \"subscription_id\": \"\",\n \"modules\": [\n {\n \"plan_item_id\": \"\",\n \"plan_item_name\": \"\",\n \"plan_item_description\": \"\",\n \"plan_item_internal_id\": \"\"\n },\n {\n \"plan_item_id\": \"\",\n \"plan_item_name\": \"\",\n \"plan_item_description\": \"\",\n \"plan_item_internal_id\": \"\"\n }\n ]\n }\n]", + "cookie": [], + "_postman_previewlanguage": "json" } - ] + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } }, - "method": "POST", - "header": [ - { - "key": "Accept", - "value": "application/json", - "description": "" - }, - { - "key": "Content-Type", - "value": "application/json", - "description": "" + { + "id": "cf7df607-1d37-4157-b620-297742db5b3c", + "name": "Creates a new Docusign account using the plan and modules specified in request body.", + "request": { + "name": "Creates a new Docusign account using the plan and modules specified in request body.", + "description": { + "content": "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`", + "type": "text/plain" + }, + "url": { + "path": [ + "v2", + "organizations", + ":organizationId", + "assetGroups", + "accountCreate" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [ + { + "type": "any", + "value": "", + "key": "organizationId", + "disabled": false, + "description": { + "content": "(Required) The organization's GUID.\n", + "type": "text/plain" + } + } + ] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"subscriptionDetails\": {\n \"id\": \"\",\n \"planId\": \"\",\n \"modules\": [\n \"\",\n \"\"\n ]\n },\n \"targetAccount\": {\n \"id\": \"\",\n \"address\": {\n \"street_address\": \"\",\n \"street_address_2\": \"\",\n \"locality\": \"\",\n \"region\": \"\",\n \"postal_code\": \"\",\n \"country\": \"\",\n \"phone\": \"\",\n \"fax\": \"\"\n },\n \"admin\": {\n \"address\": {\n \"street_address\": \"\",\n \"street_address_2\": \"\",\n \"locality\": \"\",\n \"region\": \"\",\n \"postal_code\": \"\",\n \"country\": \"\",\n \"phone\": \"\",\n \"fax\": \"\"\n },\n \"email\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"locale\": \"pt_br\"\n },\n \"name\": \"\",\n \"countryCode\": \"\",\n \"region\": \"\",\n \"site\": \"\"\n }\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "auth": null }, - { - "key": "Authorization", - "value": "Bearer {{accessToken}}", - "description": "" + "response": [ + { + "id": "148db4ef-e71b-4586-9cef-ddaa4679563e", + "name": "OK", + "originalRequest": { + "url": { + "path": [ + "v2", + "organizations", + ":organizationId", + "assetGroups", + "accountCreate" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"subscriptionDetails\": {\n \"id\": \"\",\n \"planId\": \"\",\n \"modules\": [\n \"\",\n \"\"\n ]\n },\n \"targetAccount\": {\n \"id\": \"\",\n \"address\": {\n \"street_address\": \"\",\n \"street_address_2\": \"\",\n \"locality\": \"\",\n \"region\": \"\",\n \"postal_code\": \"\",\n \"country\": \"\",\n \"phone\": \"\",\n \"fax\": \"\"\n },\n \"admin\": {\n \"address\": {\n \"street_address\": \"\",\n \"street_address_2\": \"\",\n \"locality\": \"\",\n \"region\": \"\",\n \"postal_code\": \"\",\n \"country\": \"\",\n \"phone\": \"\",\n \"fax\": \"\"\n },\n \"email\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"locale\": \"pt_br\"\n },\n \"name\": \"\",\n \"countryCode\": \"\",\n \"region\": \"\",\n \"site\": \"\"\n }\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + } + }, + "status": "OK", + "code": 200, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"AssetGroupWork\": {\n \"AssetGroupWorkId\": \"\",\n \"AssetGroupId\": \"\",\n \"AssetGroupWorkType\": \"AccountAssetClone\",\n \"Status\": \"Completed\",\n \"OrderId\": \"\",\n \"TargetAccountId\": \"\",\n \"SourceAccountId\": \"\",\n \"SourceAccountExternalId\": \"\",\n \"SourceAccountName\": \"\",\n \"SourceAccountSite\": \"\",\n \"CloneRequestId\": \"\",\n \"CloneAccountDetails\": {\n \"Name\": \"\",\n \"CountryCode\": \"\",\n \"Region\": \"\",\n \"Site\": \"\",\n \"Address\": {\n \"Address1\": \"\",\n \"Address2\": \"\",\n \"City\": \"\",\n \"StateProvince\": \"\",\n \"Country\": \"\",\n \"PostalCode\": \"\",\n \"Phone\": \"\",\n \"Fax\": \"\",\n \"ZipPlus4\": \"\"\n },\n \"AdminUser\": {\n \"EmailAddress\": \"\",\n \"FirstName\": \"\",\n \"LastName\": \"\",\n \"Locale\": \"it\",\n \"Address\": {\n \"Address1\": \"\",\n \"Address2\": \"\",\n \"City\": \"\",\n \"StateProvince\": \"\",\n \"Country\": \"\",\n \"PostalCode\": \"\",\n \"Phone\": \"\",\n \"Fax\": \"\",\n \"ZipPlus4\": \"\"\n }\n },\n \"BillingProfileType\": \"Direct\"\n },\n \"CreateSubAccountDetails\": {\n \"SubscriptionDetails\": {\n \"SubscriptionId\": \"\",\n \"PlanId\": \"\",\n \"Modules\": [\n \"\",\n \"\"\n ]\n },\n \"Name\": \"\",\n \"CountryCode\": \"\",\n \"Region\": \"\",\n \"Site\": \"\",\n \"Address\": {\n \"Address1\": \"\",\n \"Address2\": \"\",\n \"City\": \"\",\n \"StateProvince\": \"\",\n \"Country\": \"\",\n \"PostalCode\": \"\",\n \"Phone\": \"\",\n \"Fax\": \"\",\n \"ZipPlus4\": \"\"\n },\n \"AdminUser\": {\n \"EmailAddress\": \"\",\n \"FirstName\": \"\",\n \"LastName\": \"\",\n \"Locale\": \"None\",\n \"Address\": {\n \"Address1\": \"\",\n \"Address2\": \"\",\n \"City\": \"\",\n \"StateProvince\": \"\",\n \"Country\": \"\",\n \"PostalCode\": \"\",\n \"Phone\": \"\",\n \"Fax\": \"\",\n \"ZipPlus4\": \"\"\n }\n },\n \"BillingProfileType\": \"Web\"\n },\n \"Attempts\": \"\",\n \"RetryOn\": \"\",\n \"Message\": \"\",\n \"CreatedByName\": \"\",\n \"CreatedByEmail\": \"\",\n \"ErrorDetails\": {\n \"ErrorCode\": \"\",\n \"PublicErrorCode\": \"\",\n \"ErrorDescription\": \"\",\n \"IsSystemError\": \"\"\n },\n \"OldAssetGroupSubscriptionId\": \"\",\n \"NewAssetGroupSubscriptionId\": \"\",\n \"SourceSystem\": \"\",\n \"SourceId\": \"\",\n \"CreatedBy\": \"\",\n \"CreatedByType\": \"Restricted\",\n \"CreatedDate\": \"\",\n \"UpdatedBy\": \"\",\n \"UpdatedByType\": \"Resource\",\n \"UpdatedDate\": \"\",\n \"UpdateHistory\": [\n {\n \"EventDate\": \"\",\n \"Action\": \"\",\n \"TraceToken\": \"\"\n },\n {\n \"EventDate\": \"\",\n \"Action\": \"\",\n \"TraceToken\": \"\"\n }\n ]\n },\n \"Message\": \"\",\n \"Success\": \"\"\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true } - ], - "body": { - "mode": "raw", - "raw": "{}" }, - "description": "Required scopes: user_write" - }, - "response": [] - }, - { - "_postman_id": "b06984f8-c3b0-4ecb-bdbd-82ef0e064cad", - "name": "Updates a user's email address.", - "request": { - "url": { - "raw": "https://{{hostenv}}/Management/v2/organizations/{{organizationId}}/users/email_addresses", - "protocol": "https", - "auth": {}, - "host": [ - "{{hostenv}}" - ], - "path": [ - "Management", - "v2", - "organizations", - "{{organizationId}}", - "users", - "email_addresses" - ], - "variable": [ + { + "id": "788bd7c8-d967-4cb2-afee-e3cf748220ab", + "name": "Get all ongoing account creation processes for an Organization.", + "request": { + "name": "Get all ongoing account creation processes for an Organization.", + "description": { + "content": "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`", + "type": "text/plain" + }, + "url": { + "path": [ + "v2", + "organizations", + ":organizationId", + "subAccountsCreated" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": true, + "description": { + "content": "Specifies that the request will only return information for accounts that were created after the date passed in the format YYYY-MM-DD.", + "type": "text/plain" + }, + "key": "since_updated_date", + "value": "" + }, + { + "disabled": true, + "description": { + "content": "When `true`, include additional details about the account creation process. The default value is `false`.", + "type": "text/plain" + }, + "key": "include_details", + "value": "" + } + ], + "variable": [ + { + "type": "any", + "value": "", + "key": "organizationId", + "disabled": false, + "description": { + "content": "(Required) The organization's GUID.\n", + "type": "text/plain" + } + } + ] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "GET", + "body": {}, + "auth": null + }, + "response": [ { - "value": "{{organizationId}}", - "id": "organizationId" + "id": "aab928f4-ea53-4ba9-a9e2-ced30946bfc6", + "name": "OK", + "originalRequest": { + "url": { + "path": [ + "v2", + "organizations", + ":organizationId", + "subAccountsCreated" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": true, + "description": { + "content": "Specifies that the request will only return information for accounts that were created after the date passed in the format YYYY-MM-DD.", + "type": "text/plain" + }, + "key": "since_updated_date", + "value": "" + }, + { + "disabled": true, + "description": { + "content": "When `true`, include additional details about the account creation process. The default value is `false`.", + "type": "text/plain" + }, + "key": "include_details", + "value": "" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "GET", + "body": {} + }, + "status": "OK", + "code": 200, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"assetGroupWorks\": [\n {\n \"targetAccount\": {\n \"id\": \"\",\n \"name\": \"\",\n \"region\": \"\",\n \"countryCode\": \"\",\n \"site\": \"\",\n \"admin\": {\n \"email\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"locale\": \"de\"\n }\n },\n \"subscriptionDetails\": {\n \"id\": \"\",\n \"planId\": \"\",\n \"planName\": \"\",\n \"modules\": [\n {\n \"moduleId\": \"\",\n \"moduleName\": \"\"\n },\n {\n \"moduleId\": \"\",\n \"moduleName\": \"\"\n }\n ]\n },\n \"assetGroupWorkId\": \"\",\n \"assetGroupId\": \"\",\n \"assetGroupWorkType\": \"AccountAssetClone\",\n \"status\": \"Pending\",\n \"orderId\": \"\",\n \"attempts\": \"\",\n \"createdDate\": \"\",\n \"createdByName\": \"\",\n \"createdByEmail\": \"\",\n \"message\": \"\",\n \"createAccountProcessingFailureDetails\": {\n \"error\": \"\",\n \"errorDescription\": \"\",\n \"isSystemError\": \"\"\n }\n },\n {\n \"targetAccount\": {\n \"id\": \"\",\n \"name\": \"\",\n \"region\": \"\",\n \"countryCode\": \"\",\n \"site\": \"\",\n \"admin\": {\n \"email\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"locale\": \"de\"\n }\n },\n \"subscriptionDetails\": {\n \"id\": \"\",\n \"planId\": \"\",\n \"planName\": \"\",\n \"modules\": [\n {\n \"moduleId\": \"\",\n \"moduleName\": \"\"\n },\n {\n \"moduleId\": \"\",\n \"moduleName\": \"\"\n }\n ]\n },\n \"assetGroupWorkId\": \"\",\n \"assetGroupId\": \"\",\n \"assetGroupWorkType\": \"GroupAssetFulfillment\",\n \"status\": \"PermanentFailure\",\n \"orderId\": \"\",\n \"attempts\": \"\",\n \"createdDate\": \"\",\n \"createdByName\": \"\",\n \"createdByEmail\": \"\",\n \"message\": \"\",\n \"createAccountProcessingFailureDetails\": {\n \"error\": \"\",\n \"errorDescription\": \"\",\n \"isSystemError\": \"\"\n }\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" } - ] + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true + } }, - "method": "POST", - "header": [ - { - "key": "Accept", - "value": "application/json", - "description": "" - }, - { - "key": "Content-Type", - "value": "application/json", - "description": "" + { + "id": "98864a4e-bba8-4702-91f3-950b93525f1c", + "name": "Get a single account creation process.", + "request": { + "name": "Get a single account creation process.", + "description": { + "content": "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`", + "type": "text/plain" + }, + "url": { + "path": [ + "v2", + "organizations", + ":organizationId", + "assetGroup", + ":assetGroupId", + "subAccountCreated", + ":assetGroupWorkId" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": true, + "description": { + "content": "When true, include details for the asset group account clone.", + "type": "text/plain" + }, + "key": "include_details", + "value": "" + } + ], + "variable": [ + { + "type": "any", + "value": "", + "key": "organizationId", + "disabled": false, + "description": { + "content": "(Required) The organization's GUID.\n", + "type": "text/plain" + } + }, + { + "type": "any", + "value": "", + "key": "assetGroupId", + "disabled": false, + "description": { + "content": "(Required) The ID of the asset group.", + "type": "text/plain" + } + }, + { + "type": "any", + "value": "", + "key": "assetGroupWorkId", + "disabled": false, + "description": { + "content": "(Required) The ID of the asset group account clone request.", + "type": "text/plain" + } + } + ] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "GET", + "body": {}, + "auth": null }, - { - "key": "Authorization", - "value": "Bearer {{accessToken}}", - "description": "" + "response": [ + { + "id": "ef0c38bf-80ce-4828-93ec-d12e07ef50ea", + "name": "OK", + "originalRequest": { + "url": { + "path": [ + "v2", + "organizations", + ":organizationId", + "assetGroup", + ":assetGroupId", + "subAccountCreated", + ":assetGroupWorkId" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [ + { + "disabled": true, + "description": { + "content": "When true, include details for the asset group account clone.", + "type": "text/plain" + }, + "key": "include_details", + "value": "" + } + ], + "variable": [] + }, + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "method": "GET", + "body": {} + }, + "status": "OK", + "code": 200, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"targetAccount\": {\n \"id\": \"\",\n \"name\": \"\",\n \"region\": \"\",\n \"countryCode\": \"\",\n \"site\": \"\",\n \"admin\": {\n \"email\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"locale\": \"None\"\n }\n },\n \"subscriptionDetails\": {\n \"id\": \"\",\n \"planId\": \"\",\n \"planName\": \"\",\n \"modules\": [\n {\n \"moduleId\": \"\",\n \"moduleName\": \"\"\n },\n {\n \"moduleId\": \"\",\n \"moduleName\": \"\"\n }\n ]\n },\n \"assetGroupWorkId\": \"\",\n \"assetGroupId\": \"\",\n \"assetGroupWorkType\": \"AccountAssetCreate\",\n \"status\": \"ProcessingError\",\n \"orderId\": \"\",\n \"attempts\": \"\",\n \"createdDate\": \"\",\n \"createdByName\": \"\",\n \"createdByEmail\": \"\",\n \"message\": \"\",\n \"createAccountProcessingFailureDetails\": {\n \"error\": \"\",\n \"errorDescription\": \"\",\n \"isSystemError\": \"\"\n }\n}", + "cookie": [], + "_postman_previewlanguage": "json" + } + ], + "event": [], + "protocolProfileBehavior": { + "disableBodyPruning": true } - ], - "body": { - "mode": "raw", - "raw": "{}" - }, - "description": "Required scopes: user_write" - }, - "response": [] + } + ] + } + ], + "event": [], + "variable": [ + { + "key": "baseUrl", + "value": "https://api.docusign.net/Management" } - ] + ], + "info": { + "_postman_id": "ec993b08-d3dc-4024-bc06-ec967fb9d12e", + "name": "Docusign Admin API", + "schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json", + "description": "An API for an organization administrator to manage organizations, accounts and users" + } } \ No newline at end of file