{"openapi":"3.1.0","info":{"title":"core","version":"4"},"servers":[{"url":"https://api.doppler.com/"}],"components":{"securitySchemes":{"sec0":{"type":"oauth2","flows":{}}}},"security":[{"sec0":[]}],"paths":{"/v3/workplace":{"get":{"summary":"Retrieve","description":"","operationId":"workplace-get","responses":{"200":{"description":"200","content":{"application/json":{"examples":{"Result":{"value":"{\n  \"workplace\": {\n    \"id\": \"188f5\",\n    \"name\": \"Test Workplace\",\n    \"billing_email\": \"billing@example.com\",\n    \"security_email\": \"security@example.com\"\n  }\n}"}},"schema":{"type":"object","properties":{"workplace":{"type":"object","properties":{"id":{"type":"string","example":"188f5"},"name":{"type":"string","example":"Test Workplace"},"billing_email":{"type":"string","example":"billing@example.com"},"security_email":{"type":"string","example":"security@example.com"}}}}}}}}},"deprecated":false},"post":{"summary":"Update","description":"","operationId":"workplace-update","requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","description":"Workplace name"},"billing_email":{"type":"string"},"security_email":{"type":"string"}}}}}},"responses":{"200":{"description":"200","content":{"application/json":{"examples":{"Result":{"value":"{\n  \"workplace\": {\n    \"id\": \"188f5\",\n    \"name\": \"Test Workplace\",\n    \"billing_email\": \"billing@example.com\",\n    \"security_email\": \"security@example.com\"\n  }\n}"}},"schema":{"type":"object","properties":{"workplace":{"type":"object","properties":{"id":{"type":"string","example":"188f5"},"name":{"type":"string","example":"Test Workplace"},"billing_email":{"type":"string","example":"billing@example.com"},"security_email":{"type":"string","example":"security@example.com"}}}}}}}}},"deprecated":false}},"/v3/workplace/users":{"get":{"summary":"List","description":"Get all users within a workplace","operationId":"users-list","parameters":[{"name":"page","in":"query","description":"The page of users to fetch","schema":{"type":"integer","format":"int32","default":1}},{"name":"email","in":"query","description":"Filter results to only include the user with the provided email address","schema":{"type":"string"}}],"responses":{"200":{"description":"200","content":{"application/json":{"examples":{"Result":{"value":"{\n  \"workplace_users\": [\n    {\n      \"id\": \"45786c9a-8c97-4f5b-a35b-ce941796502b\",\n      \"access\": \"owner\",\n      \"created_at\": \"2020-09-01T23:57:27.052Z\",\n      \"user\": {\n        \"email\": \"test@example.com\",\n        \"name\": \"John Appleseed\",\n        \"username\": \"john\",\n        \"profile_image_url\": \"\"\n      }\n    }\n  ],\n  \"page\": 1,\n  \"success\": true\n}"}},"schema":{"type":"object","properties":{"workplace_users":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","example":"45786c9a-8c97-4f5b-a35b-ce941796502b"},"access":{"type":"string","example":"owner"},"created_at":{"type":"string","example":"2020-09-01T23:57:27.052Z"},"user":{"type":"object","properties":{"email":{"type":"string","example":"test@example.com"},"name":{"type":"string","example":"John Appleseed"},"username":{"type":"string","example":"john"},"profile_image_url":{"type":"string","example":""}}}}}},"page":{"type":"integer","example":1,"default":0},"success":{"type":"boolean","example":true,"default":true}}}}}}},"deprecated":false}},"/v3/workplace/users/{slug}":{"get":{"summary":"Retrieve","description":"Get a specific user in a workplace","operationId":"users-get","parameters":[{"name":"slug","in":"path","description":"The slug of the workplace user","schema":{"type":"string"},"required":true}],"responses":{"200":{"description":"200","content":{"application/json":{"examples":{"Result":{"value":"{\n  \"workplace_user\": {\n    \"id\": \"9629f890-eb33-426c-8694-28ce363b44f0\",\n    \"access\": \"owner\",\n    \"created_at\": \"2021-01-08T02:43:20.524Z\",\n    \"user\": {\n      \"email\": \"test@example.com\",\n      \"name\": \"John Appleseed\",\n      \"username\": \"john\",\n      \"profile_image_url\": \"\"\n    }\n  },\n  \"success\": true\n}"}},"schema":{"type":"object","properties":{"workplace_user":{"type":"object","properties":{"id":{"type":"string","example":"9629f890-eb33-426c-8694-28ce363b44f0"},"access":{"type":"string","example":"owner"},"created_at":{"type":"string","example":"2021-01-08T02:43:20.524Z"},"user":{"type":"object","properties":{"email":{"type":"string","example":"test@example.com"},"name":{"type":"string","example":"John Appleseed"},"username":{"type":"string","example":"john"},"profile_image_url":{"type":"string","example":""}}}}},"success":{"type":"boolean","example":true,"default":true}}}}}}},"deprecated":false},"patch":{"summary":"Update","description":"Update a specific user for a workplace","operationId":"users-update","parameters":[{"name":"slug","in":"path","description":"The slug of the workplace user.","schema":{"type":"string"},"required":true}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"access":{"type":"string","description":"The identifier of the workplace role. E.g., `owner`, `collaborator`, etc."}}}}}},"responses":{"200":{"description":"200","content":{"application/json":{"examples":{"Result":{"value":"{\n  \"workplace_user\": {\n    \"id\": \"9629f890-eb33-426c-8694-28ce363b44f0\",\n    \"access\": \"owner\",\n    \"created_at\": \"2021-01-08T02:43:20.524Z\",\n    \"user\": {\n      \"email\": \"test@example.com\",\n      \"name\": \"John Appleseed\",\n      \"username\": \"john\",\n      \"profile_image_url\": \"\"\n    }\n  },\n  \"success\": true\n}"}},"schema":{"type":"object","properties":{"workplace_user":{"type":"object","properties":{"id":{"type":"string","example":"9629f890-eb33-426c-8694-28ce363b44f0"},"access":{"type":"string","example":"owner"},"created_at":{"type":"string","example":"2021-01-08T02:43:20.524Z"},"user":{"type":"object","properties":{"email":{"type":"string","example":"test@example.com"},"name":{"type":"string","example":"John Appleseed"},"username":{"type":"string","example":"john"},"profile_image_url":{"type":"string","example":""}}}}},"success":{"type":"boolean","example":true,"default":true}}}}}}},"deprecated":false}},"/v3/workplace/roles":{"get":{"summary":"List","description":"","operationId":"workplace_roles-list","responses":{"200":{"description":"200","content":{"application/json":{"examples":{"Result":{"value":"{\n  \"roles\": [{\n    \"name\": \"custom\",\n    \"permissions\": [\"team\"],\n    \"identifier\": \"custom\",\n    \"created_at\": \"2023-08-01T00:00:00.000Z\",\n    \"is_custom_role\": false,\n    \"is_inline_role\": false\n\t}]\n}"}},"schema":{"type":"object","properties":{"roles":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","example":"custom"},"permissions":{"type":"array","items":{"type":"string","example":"team"}},"identifier":{"type":"string","example":"custom"},"created_at":{"type":"string","example":"2023-08-01T00:00:00.000Z"},"is_custom_role":{"type":"boolean","example":false,"default":true},"is_inline_role":{"type":"boolean","example":false,"default":true}}}}}}}}}},"deprecated":false},"post":{"summary":"Create","description":"","operationId":"workplace_roles-create","requestBody":{"content":{"application/json":{"schema":{"type":"object","required":["name","permissions"],"properties":{"name":{"type":"string","description":"The name of the role"},"permissions":{"type":"array","description":"An array containing the permissions the role has. Valid permissions are: `all_enclave_projects`, `all_enclave_projects_admin`, `analytics_dashboard`, `billing`, `billing_manage`, `change_request_policy_manage`, `change_request_policy_read`, `create_enclave_project`, `custom_roles_manage`, `ekm`, `enclave_inheritance`, `enclave_secrets_referencing`, `logs`, `logs_audit`, `service_account_api_tokens`, `service_account_api_tokens_manage`, `service_account_identities`, `service_account_identities_manage`, `service_accounts`, `service_accounts_manage`, `settings`, `settings_manage`, `team`, `team_manage`, `verified_domains`, `verified_domains_manage`, `workplace_default_environments_manage`, `workplace_default_environments_read`, `workplace_integrations_create`, `workplace_integrations_list`, `workplace_integrations_manage`, `workplace_integrations_read`","items":{"type":"string"}}}}}}},"responses":{"200":{"description":"200","content":{"application/json":{"examples":{"Result":{"value":"{\n  \"role\": {\n    \"name\": \"custom\",\n    \"permissions\": [\"team\"],\n    \"identifier\": \"custom\",\n    \"created_at\": \"2023-08-01T00:00:00.000Z\",\n    \"is_custom_role\": true,\n    \"is_inline_role\": false\n\t}\n}"}},"schema":{"type":"object","properties":{"role":{"type":"object","properties":{"name":{"type":"string","example":"custom"},"permissions":{"type":"array","items":{"type":"string","example":"team"}},"identifier":{"type":"string","example":"custom"},"created_at":{"type":"string","example":"2023-08-01T00:00:00.000Z"},"is_custom_role":{"type":"boolean","example":true,"default":true},"is_inline_role":{"type":"boolean","example":false,"default":true}}}}}}}}},"deprecated":false}},"/v3/workplace/roles/role/{role}":{"get":{"summary":"Retrieve","description":"","operationId":"workplace_roles-get","parameters":[{"name":"role","in":"path","description":"The role's unique identifier","schema":{"type":"string"},"required":true}],"responses":{"200":{"description":"200","content":{"application/json":{"examples":{"Result":{"value":"{\n  \"role\": {\n    \"name\": \"custom\",\n    \"permissions\": [\"team\"],\n    \"identifier\": \"custom\",\n    \"created_at\": \"2023-08-01T00:00:00.000Z\",\n    \"is_custom_role\": false,\n    \"is_inline_role\": false\n\t}\n}"}},"schema":{"type":"object","properties":{"role":{"type":"object","properties":{"name":{"type":"string","example":"custom"},"permissions":{"type":"array","items":{"type":"string","example":"team"}},"identifier":{"type":"string","example":"custom"},"created_at":{"type":"string","example":"2023-08-01T00:00:00.000Z"},"is_custom_role":{"type":"boolean","example":false,"default":true},"is_inline_role":{"type":"boolean","example":false,"default":true}}}}}}}},"404":{"description":"404","content":{"text/plain":{"examples":{"Result":{"value":""}}}}}},"deprecated":false},"patch":{"summary":"Update","description":"","operationId":"workplace_roles-update","parameters":[{"name":"role","in":"path","description":"The role's unique identifier, which is the initial name the role was given","schema":{"type":"string"},"required":true}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","description":"The name of the role"},"permissions":{"type":"array","description":"An array containing the permissions the role has. Valid permissions are: `all_enclave_projects`, `all_enclave_projects_admin`, `analytics_dashboard`, `billing`, `billing_manage`, `change_request_policy_manage`, `change_request_policy_read`, `create_enclave_project`, `custom_roles_manage`, `ekm`, `enclave_inheritance`, `enclave_secrets_referencing`, `logs`, `logs_audit`, `service_account_api_tokens`, `service_account_api_tokens_manage`, `service_account_identities`, `service_account_identities_manage`, `service_accounts`, `service_accounts_manage`, `settings`, `settings_manage`, `team`, `team_manage`, `verified_domains`, `verified_domains_manage`, `workplace_default_environments_manage`, `workplace_default_environments_read`, `workplace_integrations_create`, `workplace_integrations_list`, `workplace_integrations_manage`, `workplace_integrations_read`","items":{"type":"string"}}}}}}},"responses":{"200":{"description":"200","content":{"application/json":{"examples":{"Result":{"value":"{\n  \"role\": {\n    \"name\": \"custom\",\n    \"permissions\": [\"team\"],\n    \"identifier\": \"custom\",\n    \"created_at\": \"2023-08-01T00:00:00.000Z\",\n    \"is_custom_role\": true,\n    \"is_inline_role\": false\n\t}\n}"}},"schema":{"type":"object","properties":{"role":{"type":"object","properties":{"name":{"type":"string","example":"custom"},"permissions":{"type":"array","items":{"type":"string","example":"team"}},"identifier":{"type":"string","example":"custom"},"created_at":{"type":"string","example":"2023-08-01T00:00:00.000Z"},"is_custom_role":{"type":"boolean","example":true,"default":true},"is_inline_role":{"type":"boolean","example":false,"default":true}}}}}}}},"404":{"description":"404","content":{"application/json":{"examples":{"Result":{"value":"{}"}},"schema":{"type":"object","properties":{}}}}}},"deprecated":false},"delete":{"summary":"Delete","description":"","operationId":"workplace_roles-delete","parameters":[{"name":"role","in":"path","description":"The role's unique identifier","schema":{"type":"string"},"required":true}],"responses":{"204":{"description":"204","content":{"application/json":{"examples":{"Result":{"value":""}}}}},"404":{"description":"404","content":{"application/json":{"examples":{"Result":{"value":"{}"}},"schema":{"type":"object","properties":{}}}}}},"deprecated":false}},"/v3/workplace/permissions":{"get":{"summary":"List Permissions","description":"","operationId":"workplace_roles-list_permissions","responses":{"200":{"description":"200","content":{"application/json":{"examples":{"Result":{"value":"{\n  \"permissions\": [\"team\"]\n}"}},"schema":{"type":"object","properties":{"permissions":{"type":"array","items":{"type":"string","example":"team"}}}}}}}},"deprecated":false}},"/v3/logs":{"get":{"summary":"List","description":"Activity Logs","operationId":"activity_logs-list","parameters":[{"name":"page","in":"query","description":"Page number","schema":{"type":"string","default":"1"}},{"name":"per_page","in":"query","description":"Items per page","schema":{"type":"integer","format":"int32","default":20}}],"responses":{"200":{"description":"200","content":{"application/json":{"examples":{"Result":{"value":"{\n  \"page\": 1,\n  \"logs\": [\n    {\n      \"id\": \"emwk7ra70oem3xa\",\n      \"text\": \"Modified Development defaults in Pied Piper Demo project\",\n      \"html\": \"Modified <a href='/workplace/103/projects/wk7radvodfneb/defaults?stage=dev'>Development's</a> defaults in <a href='/workplace/wk7radvodfneb/pipelines/410'>Pied Piper Demo</a> project\",\n      \"created_at\": \"2019-04-01T21:40:34.891Z\",\n      \"config\": null,\n      \"environment\": \"dev\",\n      \"project\": \"wk7radvodfneb\",\n      \"user\": {\n        \"email\": \"adam@piedpiper.com\",\n        \"name\": \"Adam Smitth\",\n        \"profile_image_url\": \"https://www.gravatar.com/avatar/082c73740a33762db7c5cc7481833e1e?s=500&d=retro\"\n      }\n    }\n  ]\n}"}},"schema":{"type":"object","properties":{"page":{"type":"integer","example":1,"default":0},"logs":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","example":"emwk7ra70oem3xa"},"text":{"type":"string","example":"Modified Development defaults in Pied Piper Demo project"},"html":{"type":"string","example":"Modified <a href='/workplace/103/projects/wk7radvodfneb/defaults?stage=dev'>Development's</a> defaults in <a href='/workplace/wk7radvodfneb/pipelines/410'>Pied Piper Demo</a> project"},"created_at":{"type":"string","example":"2019-04-01T21:40:34.891Z"},"config":{},"environment":{"type":"string","example":"dev"},"project":{"type":"string","example":"wk7radvodfneb"},"user":{"type":"object","properties":{"email":{"type":"string","example":"adam@piedpiper.com"},"name":{"type":"string","example":"Adam Smitth"},"profile_image_url":{"type":"string","example":"https://www.gravatar.com/avatar/082c73740a33762db7c5cc7481833e1e?s=500&d=retro"}}}}}}}}}}}},"deprecated":false}},"/v3/logs/log":{"get":{"summary":"Retrieve","description":"Activity Log","operationId":"activity_logs-retrieve","parameters":[{"name":"log","in":"query","description":"Unique identifier for the log object.","required":true,"schema":{"type":"string","default":"LOG_ID"}}],"responses":{"200":{"description":"200","content":{"application/json":{"examples":{"Result":{"value":"{\n  \"log\": {\n    \"id\": \"emwk7ra70oem3xa\",\n    \"text\": \"Modified Development defaults in Pied Piper Demo project\",\n    \"html\": \"Modified <a href='/workplace/103/projects/wk7radvodfneb/defaults?stage=dev'>Development's</a> defaults in <a href='/workplace/wk7radvodfneb/pipelines/410'>Pied Piper Demo</a> project\",\n    \"created_at\": \"2019-04-01T21:40:34.891Z\",\n    \"config\": null,\n    \"environment\": \"dev\",\n    \"project\": \"wk7radvodfneb\",\n    \"user\": {\n      \"email\": \"adam@piedpiper.com\",\n      \"name\": \"Adam Smitth\",\n      \"profile_image_url\": \"https://www.gravatar.com/avatar/082c73740a33762db7c5cc7481833e1e?s=500&d=retro\"\n    }\n  }\n}"}},"schema":{"type":"object","properties":{"log":{"type":"object","properties":{"id":{"type":"string","example":"emwk7ra70oem3xa"},"text":{"type":"string","example":"Modified Development defaults in Pied Piper Demo project"},"html":{"type":"string","example":"Modified <a href='/workplace/103/projects/wk7radvodfneb/defaults?stage=dev'>Development's</a> defaults in <a href='/workplace/wk7radvodfneb/pipelines/410'>Pied Piper Demo</a> project"},"created_at":{"type":"string","example":"2019-04-01T21:40:34.891Z"},"config":{},"environment":{"type":"string","example":"dev"},"project":{"type":"string","example":"wk7radvodfneb"},"user":{"type":"object","properties":{"email":{"type":"string","example":"adam@piedpiper.com"},"name":{"type":"string","example":"Adam Smitth"},"profile_image_url":{"type":"string","example":"https://www.gravatar.com/avatar/082c73740a33762db7c5cc7481833e1e?s=500&d=retro"}}}}}}}}}}},"deprecated":false}},"/v3/projects":{"get":{"summary":"List","description":"Projects","operationId":"projects-list","parameters":[{"name":"page","in":"query","description":"Page number","schema":{"type":"integer","format":"int32","default":1}},{"name":"per_page","in":"query","description":"Items per page","schema":{"type":"integer","format":"int32","default":20}}],"responses":{"200":{"description":"200","content":{"application/json":{"examples":{"Result":{"value":"{\n  \"page\": 1,\n  \"projects\": [\n    {\n      \"id\": \"ed0c2a68b6\",\n      \"slug\": \"compression\",\n      \"name\": \"Compression\",\n      \"description\": \"Super rad middle-out compression algo.\",\n      \"created_at\": \"2019-03-26T03:16:20.233Z\"\n    }\n  ]\n}"}},"schema":{"type":"object","properties":{"page":{"type":"integer","example":1,"default":0},"projects":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","example":"ed0c2a68b6"},"slug":{"type":"string","example":"compression"},"name":{"type":"string","example":"Compression"},"description":{"type":"string","example":"Super rad middle-out compression algo."},"created_at":{"type":"string","example":"2019-03-26T03:16:20.233Z"}}}}}}}}}},"deprecated":false},"post":{"summary":"Create","description":"Project","operationId":"projects-create","requestBody":{"content":{"application/json":{"schema":{"type":"object","required":["name"],"properties":{"name":{"type":"string","description":"Name of project","default":"PROJECT_NAME"},"description":{"type":"string","description":"Description of project","default":"PROJECT_DESCRIPTION"}}}}}},"responses":{"200":{"description":"200","content":{"application/json":{"examples":{"Result":{"value":"{\n  \"project\": {\n    \"id\": \"ed0c2a68b6\",\n    \"name\": \"Compression\",\n    \"description\": \"Super rad middle-out compression algo.\",\n    \"created_at\": \"2019-03-26T03:16:20.233Z\"\n  }\n}"}},"schema":{"type":"object","properties":{"project":{"type":"object","properties":{"id":{"type":"string","example":"ed0c2a68b6"},"name":{"type":"string","example":"Compression"},"description":{"type":"string","example":"Super rad middle-out compression algo."},"created_at":{"type":"string","example":"2019-03-26T03:16:20.233Z"}}}}}}}}},"deprecated":false}},"/v3/projects/project":{"get":{"summary":"Retrieve","description":"Project","operationId":"projects-get","parameters":[{"name":"project","in":"query","description":"Unique identifier for the project object.","required":true,"schema":{"type":"string","default":"PROJECT_NAME"}}],"responses":{"200":{"description":"200","content":{"application/json":{"examples":{"Result":{"value":"{\n  \"project\": {\n    \"id\": \"ed0c2a68b6\",\n    \"name\": \"Compression\",\n    \"description\": \"Super rad middle-out compression algo.\",\n    \"created_at\": \"2019-03-26T03:16:20.233Z\"\n  }\n}"}},"schema":{"type":"object","properties":{"project":{"type":"object","properties":{"id":{"type":"string","example":"ed0c2a68b6"},"name":{"type":"string","example":"Compression"},"description":{"type":"string","example":"Super rad middle-out compression algo."},"created_at":{"type":"string","example":"2019-03-26T03:16:20.233Z"}}}}}}}}},"deprecated":false},"post":{"summary":"Update","description":"Project","operationId":"projects-update","requestBody":{"content":{"application/json":{"schema":{"type":"object","required":["project","name"],"properties":{"project":{"type":"string","description":"Unique identifier for the project object.","default":"PROJECT_NAME"},"name":{"type":"string","description":"Name of the project.","default":"PROJECT_NEW_NAME"},"description":{"type":"string","description":"Description of the project.","default":"PROJECT_DESCRIPTION"}}}}}},"responses":{"200":{"description":"200","content":{"application/json":{"examples":{"Result":{"value":"{\n  \"project\": {\n    \"id\": \"ed0c2a68b6\",\n    \"name\": \"Compression\",\n    \"description\": \"Super rad middle-out compression algo.\",\n    \"created_at\": \"2019-03-26T03:16:20.233Z\"\n  }\n}"}},"schema":{"type":"object","properties":{"project":{"type":"object","properties":{"id":{"type":"string","example":"ed0c2a68b6"},"name":{"type":"string","example":"Compression"},"description":{"type":"string","example":"Super rad middle-out compression algo."},"created_at":{"type":"string","example":"2019-03-26T03:16:20.233Z"}}}}}}}}},"deprecated":false},"delete":{"summary":"Delete","description":"Project","operationId":"projects-delete","requestBody":{"content":{"application/json":{"schema":{"type":"object","required":["project"],"properties":{"project":{"type":"string","description":"Unique identifier for the project object.","default":"PROJECT_NAME"}}}}}},"responses":{"200":{"description":"200","content":{"application/json":{"examples":{"Result":{"value":"{\n  success: true\n}"}}}}}},"deprecated":false}},"/v3/projects/roles":{"get":{"summary":"List","description":"","operationId":"project_roles-list","responses":{"200":{"description":"200","content":{"application/json":{"examples":{"Result":{"value":"{\n  \"roles\": [{\n    \"name\": \"custom\",\n    \"permissions\": [\"enclave_config_logs\"],\n    \"identifier\": \"custom\",\n    \"created_at\": \"2023-08-01T00:00:00.000Z\",\n    \"is_custom_role\": false\n\t}]\n}"}},"schema":{"type":"object","properties":{"roles":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","example":"custom"},"permissions":{"type":"array","items":{"type":"string","example":"enclave_config_logs"}},"identifier":{"type":"string","example":"custom"},"created_at":{"type":"string","example":"2023-08-01T00:00:00.000Z"},"is_custom_role":{"type":"boolean","example":false,"default":true}}}}}}}}}},"deprecated":false},"post":{"summary":"Create","description":"","operationId":"project_roles-create","requestBody":{"content":{"application/json":{"schema":{"type":"object","required":["name","permissions"],"properties":{"name":{"type":"string","description":"The name of the role"},"permissions":{"type":"array","description":"An array containing the permissions the role has. Valid permissions are: `enclave_config_access_logs`, `enclave_config_change_request_policy_manage`, `enclave_config_change_request_review`, `enclave_config_logs`, `enclave_config_secrets_referencing`, `enclave_config_syncs_manage`, `enclave_config_toggle_inheritable`, `enclave_project_config_create`, `enclave_project_config_delete`, `enclave_project_config_duplicate`, `enclave_project_config_dynamic_secrets_leases_write`, `enclave_project_config_dynamic_secrets_manage`, `enclave_project_config_dynamic_secrets_read`, `enclave_project_config_lock`, `enclave_project_config_logs_rollback`, `enclave_project_config_rename`, `enclave_project_config_rotated_secrets_manage`, `enclave_project_config_rotated_secrets_read`, `enclave_project_config_secrets_read`, `enclave_project_config_secrets_write`, `enclave_project_config_service_tokens`, `enclave_project_config_trusted_ips`, `enclave_project_delete`, `enclave_project_environment_all`, `enclave_project_environment_create`, `enclave_project_environment_delete`, `enclave_project_environment_list_all`, `enclave_project_environment_order`, `enclave_project_environment_rename`, `enclave_project_environment_settings_manage`, `enclave_project_inheritance`, `enclave_project_members`, `enclave_project_rename`, `enclave_project_secrets_notes_manage`, `enclave_project_secrets_referencing`, `enclave_project_webhooks`, `enclave_secret_reminders`","items":{"type":"string"}}}}}}},"responses":{"200":{"description":"200","content":{"application/json":{"examples":{"Result":{"value":"{\n  \"role\": {\n    \"name\": \"custom\",\n    \"permissions\": [\"enclave_config_logs\"],\n    \"identifier\": \"custom\",\n    \"created_at\": \"2023-08-01T00:00:00.000Z\",\n    \"is_custom_role\": true\n\t}\n}"}},"schema":{"type":"object","properties":{"role":{"type":"object","properties":{"name":{"type":"string","example":"custom"},"permissions":{"type":"array","items":{"type":"string","example":"enclave_config_logs"}},"identifier":{"type":"string","example":"custom"},"created_at":{"type":"string","example":"2023-08-01T00:00:00.000Z"},"is_custom_role":{"type":"boolean","example":true,"default":true}}}}}}}}},"deprecated":false}},"/v3/projects/roles/role/{role}":{"get":{"summary":"Retrieve","description":"","operationId":"project_roles-get","parameters":[{"name":"role","in":"path","description":"The role's unique identifier","schema":{"type":"string"},"required":true}],"responses":{"200":{"description":"200","content":{"application/json":{"examples":{"Result":{"value":"{\n  \"role\": {\n    \"name\": \"custom\",\n    \"permissions\": [\"enclave_config_logs\"],\n    \"identifier\": \"custom\",\n    \"created_at\": \"2023-08-01T00:00:00.000Z\",\n    \"is_custom_role\": false\n\t}\n}"}},"schema":{"type":"object","properties":{"role":{"type":"object","properties":{"name":{"type":"string","example":"custom"},"permissions":{"type":"array","items":{"type":"string","example":"enclave_config_logs"}},"identifier":{"type":"string","example":"custom"},"created_at":{"type":"string","example":"2023-08-01T00:00:00.000Z"},"is_custom_role":{"type":"boolean","example":false,"default":true}}}}}}}},"404":{"description":"404","content":{"application/json":{"examples":{"Result":{"value":""}}}}}},"deprecated":false},"patch":{"summary":"Update","description":"","operationId":"project_roles-update","parameters":[{"name":"role","in":"path","description":"The role's unique identifier","schema":{"type":"string"},"required":true}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","description":"The name of the role"},"permissions":{"type":"array","description":"An array containing the permissions the role has. Valid permissions are: `enclave_config_access_logs`, `enclave_config_change_request_policy_manage`, `enclave_config_change_request_review`, `enclave_config_logs`, `enclave_config_secrets_referencing`, `enclave_config_syncs_manage`, `enclave_config_toggle_inheritable`, `enclave_project_config_create`, `enclave_project_config_delete`, `enclave_project_config_duplicate`, `enclave_project_config_dynamic_secrets_leases_write`, `enclave_project_config_dynamic_secrets_manage`, `enclave_project_config_dynamic_secrets_read`, `enclave_project_config_lock`, `enclave_project_config_logs_rollback`, `enclave_project_config_rename`, `enclave_project_config_rotated_secrets_manage`, `enclave_project_config_rotated_secrets_read`, `enclave_project_config_secrets_read`, `enclave_project_config_secrets_write`, `enclave_project_config_service_tokens`, `enclave_project_config_trusted_ips`, `enclave_project_delete`, `enclave_project_environment_all`, `enclave_project_environment_create`, `enclave_project_environment_delete`, `enclave_project_environment_list_all`, `enclave_project_environment_order`, `enclave_project_environment_rename`, `enclave_project_environment_settings_manage`, `enclave_project_inheritance`, `enclave_project_members`, `enclave_project_rename`, `enclave_project_secrets_notes_manage`, `enclave_project_secrets_referencing`, `enclave_project_webhooks`, `enclave_secret_reminders`","items":{"type":"string"}}}}}}},"responses":{"200":{"description":"200","content":{"application/json":{"examples":{"Result":{"value":"{\n  \"role\": {\n    \"name\": \"custom\",\n    \"permissions\": [\"enclave_config_logs\"],\n    \"identifier\": \"custom\",\n    \"created_at\": \"2023-08-01T00:00:00.000Z\",\n    \"is_custom_role\": true\n\t}\n}"}},"schema":{"type":"object","properties":{"role":{"type":"object","properties":{"name":{"type":"string","example":"custom"},"permissions":{"type":"array","items":{"type":"string","example":"enclave_config_logs"}},"identifier":{"type":"string","example":"custom"},"created_at":{"type":"string","example":"2023-08-01T00:00:00.000Z"},"is_custom_role":{"type":"boolean","example":true,"default":true}}}}}}}},"404":{"description":"404","content":{"application/json":{"examples":{"Result":{"value":"{}"}},"schema":{"type":"object","properties":{}}}}}},"deprecated":false},"delete":{"summary":"Delete","description":"","operationId":"project_roles-delete","parameters":[{"name":"role","in":"path","description":"The role's unique identifier","schema":{"type":"string"},"required":true}],"responses":{"204":{"description":"204","content":{"application/json":{"examples":{"Result":{"value":""}}}}},"404":{"description":"404","content":{"application/json":{"examples":{"Result":{"value":"{}"}},"schema":{"type":"object","properties":{}}}}}},"deprecated":false}},"/v3/projects/permissions":{"get":{"summary":"List Permissions","description":"","operationId":"project_roles-list_permissions","responses":{"200":{"description":"200","content":{"application/json":{"examples":{"Result":{"value":"{\n  \"permissions\": [\"enclave_config_logs\"]\n}"}},"schema":{"type":"object","properties":{"permissions":{"type":"array","items":{"type":"string","example":"enclave_config_logs"}}}}}}}},"deprecated":false}},"/v3/projects/project/members":{"get":{"summary":"List","description":"","operationId":"project_members-list","parameters":[{"name":"project","in":"query","description":"Project slug","required":true,"schema":{"type":"string"}},{"name":"page","in":"query","schema":{"type":"integer","format":"int32","default":1}},{"name":"per_page","in":"query","schema":{"type":"integer","format":"int32","default":20}}],"responses":{"200":{"description":"200","content":{"application/json":{"examples":{"Result":{"value":"{\n  \"members\": [{\n    \"type\": \"workplace_user\",\n    \"slug\": \"00000000-0000-0000-0000-000000000000\",\n    \"role\": {\n    \t\"identifier\": \"collaborator\"\n    },\n    \"access_all_environments\": false,\n    \"environments\": [\"dev\"]\n  }]\n}"}},"schema":{"type":"object","properties":{"members":{"type":"array","items":{"type":"object","properties":{"type":{"type":"string","example":"workplace_user"},"slug":{"type":"string","example":"00000000-0000-0000-0000-000000000000"},"role":{"type":"object","properties":{"identifier":{"type":"string","example":"collaborator"}}},"access_all_environments":{"type":"boolean","example":false,"default":true},"environments":{"type":"array","items":{"type":"string","example":"dev"}}}}}}}}}}},"deprecated":false},"post":{"summary":"Add","description":"","operationId":"project_members-add","parameters":[{"name":"project","in":"query","description":"Project slug","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","required":["type","slug"],"properties":{"type":{"type":"string","enum":["workplace_user","group","invite","service_account"]},"slug":{"type":"string","description":"Member's slug"},"role":{"type":"string","description":"Identifier of the project role"},"environments":{"type":"array","description":"Environment slugs to grant the member access to","items":{"type":"string"}}}}}}},"responses":{"200":{"description":"200","content":{"application/json":{"examples":{"Result":{"value":"{\n  \"member\": {\n    \"type\": \"workplace_user\",\n    \"slug\": \"00000000-0000-0000-0000-000000000000\",\n    \"role\": {\n    \t\"identifier\": \"collaborator\"\n    },\n    \"access_all_environments\": false,\n    \"environments\": [\"dev\"]\n  }\n}"}},"schema":{"type":"object","properties":{"member":{"type":"object","properties":{"type":{"type":"string","example":"workplace_user"},"slug":{"type":"string","example":"00000000-0000-0000-0000-000000000000"},"role":{"type":"object","properties":{"identifier":{"type":"string","example":"collaborator"}}},"access_all_environments":{"type":"boolean","example":false,"default":true},"environments":{"type":"array","items":{"type":"string","example":"dev"}}}}}}}}}},"deprecated":false}},"/v3/projects/project/members/member/{type}/{slug}":{"get":{"summary":"Retrieve","description":"","operationId":"project_members-get","parameters":[{"name":"project","in":"query","description":"Project slug","required":true,"schema":{"type":"string"}},{"name":"type","in":"path","schema":{"type":"string","enum":["workplace_user","group","invite","service_account"]},"required":true},{"name":"slug","in":"path","description":"Member's slug","schema":{"type":"string"},"required":true}],"responses":{"200":{"description":"200","content":{"application/json":{"examples":{"Result":{"value":"{\n  \"member\": {\n    \"type\": \"workplace_user\",\n    \"slug\": \"00000000-0000-0000-0000-000000000000\",\n    \"role\": {\n    \t\"identifier\": \"collaborator\"\n    },\n    \"access_all_environments\": false,\n    \"environments\": [\"dev\"]\n  }\n}"}},"schema":{"type":"object","properties":{"member":{"type":"object","properties":{"type":{"type":"string","example":"workplace_user"},"slug":{"type":"string","example":"00000000-0000-0000-0000-000000000000"},"role":{"type":"object","properties":{"identifier":{"type":"string","example":"collaborator"}}},"access_all_environments":{"type":"boolean","example":false,"default":true},"environments":{"type":"array","items":{"type":"string","example":"dev"}}}}}}}}}},"deprecated":false},"patch":{"summary":"Update","description":"","operationId":"project_members-update","parameters":[{"name":"type","in":"path","required":true,"schema":{"type":"string","enum":["workplace_user","group","invite","service_account"]}},{"name":"slug","in":"path","description":"Member's slug","required":true,"schema":{"type":"string"}},{"name":"project","in":"query","description":"Project slug","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"role":{"type":"string","description":"Identifier of the project role"},"environments":{"type":"array","description":"Environment slugs to grant the member access to","items":{"type":"string"}}}}}}},"responses":{"200":{"description":"200","content":{"application/json":{"examples":{"Result":{"value":"{\n  \"member\": {\n    \"type\": \"workplace_user\",\n    \"slug\": \"00000000-0000-0000-0000-000000000000\",\n    \"role\": {\n    \t\"identifier\": \"collaborator\"\n    },\n    \"access_all_environments\": false,\n    \"environments\": [\"dev\"]\n  }\n}"}},"schema":{"type":"object","properties":{"member":{"type":"object","properties":{"type":{"type":"string","example":"workplace_user"},"slug":{"type":"string","example":"00000000-0000-0000-0000-000000000000"},"role":{"type":"object","properties":{"identifier":{"type":"string","example":"collaborator"}}},"access_all_environments":{"type":"boolean","example":false,"default":true},"environments":{"type":"array","items":{"type":"string","example":"dev"}}}}}}}}}},"deprecated":false},"delete":{"summary":"Delete","description":"","operationId":"project_members-delete","parameters":[{"name":"type","in":"path","required":true,"schema":{"type":"string","enum":["workplace_user","group","invite","service_account"]}},{"name":"slug","in":"path","description":"Member's slug","required":true,"schema":{"type":"string"}},{"name":"project","in":"query","description":"Project slug","required":true,"schema":{"type":"string"}}],"responses":{"204":{"description":"204","content":{"application/json":{"examples":{"Result":{"value":""}}}}}},"deprecated":false}},"/v3/environments":{"get":{"summary":"List","description":"Environments","operationId":"environments-list","parameters":[{"name":"project","in":"query","description":"The project's name","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"200","content":{"application/json":{"examples":{"Result":{"value":"{\n  \"environments\": [\n    {\n      \"id\": \"dev\",\n      \"name\": \"Development\",\n      \"initial_fetch_at\": \"2019-11-21T03:45:47.982Z\",\n      \"created_at\": \"2019-11-19T07:19:00.476Z\",\n      \"project\": \"ed0c2a68b6\"\n    },\n    {\n      \"id\": \"stg\",\n      \"name\": \"Staging\",\n      \"initial_fetch_at\": null,\n      \"created_at\": \"2019-11-19T07:19:00.484Z\",\n      \"project\": \"ed0c2a68b6\"\n    },\n    {\n      \"id\": \"prd\",\n      \"name\": \"Production\",\n      \"initial_fetch_at\": null,\n      \"created_at\": \"2019-11-19T07:19:00.492Z\",\n      \"project\": \"ed0c2a68b6\"\n    }\n  ],\n  \"page\": 1\n}"}},"schema":{"type":"object","properties":{"environments":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","example":"dev"},"name":{"type":"string","example":"Development"},"initial_fetch_at":{"type":"string","example":"2019-11-21T03:45:47.982Z"},"created_at":{"type":"string","example":"2019-11-19T07:19:00.476Z"},"project":{"type":"string","example":"ed0c2a68b6"}}}},"page":{"type":"integer","example":1,"default":0}}}}}}},"deprecated":false},"post":{"summary":"Create","description":"Environment","operationId":"environments-create","parameters":[{"name":"project","in":"query","description":"The project's name","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","required":["name","slug"],"properties":{"name":{"type":"string"},"slug":{"type":"string"},"personal_configs":{"type":"boolean","description":"Whether or not to enable personal configs for the environment","default":false}}}}}},"responses":{"200":{"description":"200","content":{"application/json":{"examples":{"Result":{"value":"{\n  \"environment\": {\n    \"id\": \"dev\",\n    \"name\": \"Development\",\n    \"initial_fetch_at\": \"2019-11-21T03:45:47.982Z\",\n    \"created_at\": \"2019-11-19T07:19:00.476Z\",\n    \"project\": \"ed0c2a68b6\"\n  }\n}"}},"schema":{"type":"object","properties":{"environment":{"type":"object","properties":{"id":{"type":"string","example":"dev"},"name":{"type":"string","example":"Development"},"initial_fetch_at":{"type":"string","example":"2019-11-21T03:45:47.982Z"},"created_at":{"type":"string","example":"2019-11-19T07:19:00.476Z"},"project":{"type":"string","example":"ed0c2a68b6"}}}}}}}}},"deprecated":false}},"/v3/environments/environment":{"get":{"summary":"Retrieve","description":"Environment","operationId":"environments-get","parameters":[{"name":"project","in":"query","description":"The project's name","required":true,"schema":{"type":"string"}},{"name":"environment","in":"query","description":"The environment's slug","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"200","content":{"application/json":{"examples":{"Result":{"value":"{\n  \"environment\": {\n    \"id\": \"dev\",\n    \"name\": \"Development\",\n    \"initial_fetch_at\": \"2019-11-21T03:45:47.982Z\",\n    \"created_at\": \"2019-11-19T07:19:00.476Z\",\n    \"project\": \"ed0c2a68b6\"\n  }\n}"}},"schema":{"type":"object","properties":{"environment":{"type":"object","properties":{"id":{"type":"string","example":"dev"},"name":{"type":"string","example":"Development"},"initial_fetch_at":{"type":"string","example":"2019-11-21T03:45:47.982Z"},"created_at":{"type":"string","example":"2019-11-19T07:19:00.476Z"},"project":{"type":"string","example":"ed0c2a68b6"}}}}}}}}},"deprecated":false},"delete":{"summary":"Delete","description":"Environment","operationId":"environments-delete","parameters":[{"name":"project","in":"query","description":"The project's name","required":true,"schema":{"type":"string"}},{"name":"environment","in":"query","description":"The environment's slug","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"200","content":{"application/json":{"examples":{"Result":{"value":"{\n  success: true\n}"}}}}}},"deprecated":false},"put":{"summary":"Rename","description":"Environment","operationId":"environments-rename","parameters":[{"name":"project","in":"query","description":"The project's name","required":true,"schema":{"type":"string"}},{"name":"environment","in":"query","description":"The environment's slug","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","description":"Desired name"},"slug":{"type":"string","description":"Desired slug"},"personal_configs":{"type":"boolean","description":"Whether or not to enable personal configs for the environment"}}}}}},"responses":{"200":{"description":"200","content":{"application/json":{"examples":{"Result":{"value":"{\n  \"environment\": {\n    \"id\": \"dev\",\n    \"name\": \"Development\",\n    \"initial_fetch_at\": \"2019-11-21T03:45:47.982Z\",\n    \"created_at\": \"2019-11-19T07:19:00.476Z\",\n    \"project\": \"ed0c2a68b6\"\n  }\n}"}},"schema":{"type":"object","properties":{"environment":{"type":"object","properties":{"id":{"type":"string","example":"dev"},"name":{"type":"string","example":"Development"},"initial_fetch_at":{"type":"string","example":"2019-11-21T03:45:47.982Z"},"created_at":{"type":"string","example":"2019-11-19T07:19:00.476Z"},"project":{"type":"string","example":"ed0c2a68b6"}}}}}}}}},"deprecated":false}},"/v3/configs":{"get":{"summary":"List","description":"Fetch all configs.","operationId":"configs-list","parameters":[{"name":"project","in":"query","description":"The project's name","required":true,"schema":{"type":"string"}},{"name":"environment","in":"query","description":"(optional) the environment from which to list configs","schema":{"type":"string","default":"Environment slug"}},{"name":"page","in":"query","description":"Page number","schema":{"type":"integer","format":"int32","default":1}},{"name":"per_page","in":"query","description":"Items per page","schema":{"type":"integer","format":"int32","default":20}}],"responses":{"200":{"description":"200","content":{"application/json":{"examples":{"Result":{"value":"{\n  \"page\": 1,\n  \"configs\": [\n    {\n      \"name\": \"dev\",\n      \"root\": true,\n      \"locked\": true,\n      \"initial_fetch_at\": \"2019-11-19T07:36:12.000Z\",\n      \"last_fetch_at\": \"2019-11-19T07:32:10.980Z\",\n      \"created_at\": \"2019-11-19T07:19:00.480Z\",\n      \"environment\": \"dev\",\n      \"project\": \"ed0c2a68b6\"\n    },\n    {\n      \"name\": \"stg\",\n      \"root\": true,\n      \"locked\": true,\n      \"initial_fetch_at\": null,\n      \"last_fetch_at\": null,\n      \"created_at\": \"2019-11-19T07:19:00.488Z\",\n      \"environment\": \"stg\",\n      \"project\": \"ed0c2a68b6\"\n    },\n    {\n      \"name\": \"prd\",\n      \"root\": true,\n      \"locked\": true,\n      \"initial_fetch_at\": null,\n      \"last_fetch_at\": null,\n      \"created_at\": \"2019-11-19T07:19:00.495Z\",\n      \"environment\": \"prd\",\n      \"project\": \"ed0c2a68b6\"\n    }\n  ]\n}"}},"schema":{"type":"object","properties":{"page":{"type":"integer","example":1,"default":0},"configs":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","example":"dev"},"root":{"type":"boolean","example":true,"default":true},"locked":{"type":"boolean","example":true,"default":true},"initial_fetch_at":{"type":"string","example":"2019-11-19T07:36:12.000Z"},"last_fetch_at":{"type":"string","example":"2019-11-19T07:32:10.980Z"},"created_at":{"type":"string","example":"2019-11-19T07:19:00.480Z"},"environment":{"type":"string","example":"dev"},"project":{"type":"string","example":"ed0c2a68b6"}}}}}}}}}},"deprecated":false},"post":{"summary":"Create","description":"Create a new branch config.","operationId":"configs-create","requestBody":{"content":{"application/json":{"schema":{"type":"object","required":["project","environment","name"],"properties":{"project":{"type":"string","description":"Unique identifier for the project object.","default":"PROJECT_NAME"},"environment":{"type":"string","description":"Identifier for the environment object.","default":"ENVIRONMENT_ID"},"name":{"type":"string","description":"Name of the new branch config.","default":"CONFIG_NAME"}}}}}},"responses":{"200":{"description":"200","content":{"application/json":{"examples":{"Result":{"value":"{\n  \"config\": {\n    \"name\": \"prd_aws\",\n    \"root\": false,\n    \"locked\": false,\n    \"initial_fetch_at\": \"2019-11-19T07:32:12.000Z\",\n    \"last_fetch_at\": \"2019-11-19T07:36:10.980Z\",\n    \"created_at\": \"2019-11-19T07:19:00.480Z\",\n    \"environment\": \"prd\",\n    \"project\": \"ed0c2a68b6\"\n  }\n}"}},"schema":{"type":"object","properties":{"config":{"type":"object","properties":{"name":{"type":"string","example":"prd_aws"},"root":{"type":"boolean","example":false,"default":true},"locked":{"type":"boolean","example":false,"default":true},"initial_fetch_at":{"type":"string","example":"2019-11-19T07:32:12.000Z"},"last_fetch_at":{"type":"string","example":"2019-11-19T07:36:10.980Z"},"created_at":{"type":"string","example":"2019-11-19T07:19:00.480Z"},"environment":{"type":"string","example":"prd"},"project":{"type":"string","example":"ed0c2a68b6"}}}}}}}}},"deprecated":false}},"/v3/configs/config":{"get":{"summary":"Retrieve","description":"Fetch a config's details.","operationId":"configs-get","parameters":[{"name":"project","in":"query","description":"Unique identifier for the project object.","required":true,"schema":{"type":"string","default":"PROJECT_NAME"}},{"name":"config","in":"query","description":"Name of the config object.","required":true,"schema":{"type":"string","default":"CONFIG_NAME"}}],"responses":{"200":{"description":"200","content":{"application/json":{"examples":{"Result":{"value":"{\n  \"config\": {\n    \"name\": \"prd_aws\",\n    \"root\": false,\n    \"locked\": false,\n    \"initial_fetch_at\": \"2019-11-19T07:32:12.000Z\",\n    \"last_fetch_at\": \"2019-11-19T07:36:10.980Z\",\n    \"created_at\": \"2019-11-19T07:19:00.480Z\",\n    \"environment\": \"prd\",\n    \"project\": \"ed0c2a68b6\"\n  }\n}"}},"schema":{"type":"object","properties":{"config":{"type":"object","properties":{"name":{"type":"string","example":"prd_aws"},"root":{"type":"boolean","example":false,"default":true},"locked":{"type":"boolean","example":false,"default":true},"initial_fetch_at":{"type":"string","example":"2019-11-19T07:32:12.000Z"},"last_fetch_at":{"type":"string","example":"2019-11-19T07:36:10.980Z"},"created_at":{"type":"string","example":"2019-11-19T07:19:00.480Z"},"environment":{"type":"string","example":"prd"},"project":{"type":"string","example":"ed0c2a68b6"}}}}}}}}},"deprecated":false},"post":{"summary":"Update","description":"Modify an existing config.","operationId":"configs-update","requestBody":{"content":{"application/json":{"schema":{"type":"object","required":["project","config","name"],"properties":{"project":{"type":"string","description":"Unique identifier for the project object.","default":"PROJECT_NAME"},"config":{"type":"string","description":"Name of the config object.","default":"CONFIG_NAME"},"name":{"type":"string","description":"The new name of config.","default":"CONFIG_NEW_NAME"}}}}}},"responses":{"200":{"description":"200","content":{"application/json":{"examples":{"Result":{"value":"{\n  \"config\": {\n    \"name\": \"prd_gcp\",\n    \"root\": false,\n    \"locked\": false,\n    \"initial_fetch_at\": \"2019-11-19T07:32:12.000Z\",\n    \"last_fetch_at\": \"2019-11-19T07:36:10.980Z\",\n    \"created_at\": \"2019-11-19T07:19:00.480Z\",\n    \"environment\": \"prd\",\n    \"project\": \"ed0c2a68b6\"\n  }\n}"}},"schema":{"type":"object","properties":{"config":{"type":"object","properties":{"name":{"type":"string","example":"prd_gcp"},"root":{"type":"boolean","example":false,"default":true},"locked":{"type":"boolean","example":false,"default":true},"initial_fetch_at":{"type":"string","example":"2019-11-19T07:32:12.000Z"},"last_fetch_at":{"type":"string","example":"2019-11-19T07:36:10.980Z"},"created_at":{"type":"string","example":"2019-11-19T07:19:00.480Z"},"environment":{"type":"string","example":"prd"},"project":{"type":"string","example":"ed0c2a68b6"}}}}}}}}},"deprecated":false},"delete":{"summary":"Delete","description":"Permanently delete the config.","operationId":"configs-delete","parameters":[{"name":"project","in":"query","description":"Unique identifier for the project.","required":true,"schema":{"type":"string"}},{"name":"config","in":"query","description":"Name of the config.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"200","content":{"application/json":{"examples":{"Result":{"value":"{\n  \"success\": true\n}"}},"schema":{"type":"object","properties":{"success":{"type":"boolean","example":true,"default":true}}}}}}},"deprecated":false}},"/v3/configs/config/clone":{"post":{"summary":"Clone","description":"Create a new branch config by cloning another. This duplicates a branch config and all its secrets.","operationId":"configs-clone","requestBody":{"content":{"application/json":{"schema":{"type":"object","required":["project","config","name"],"properties":{"project":{"type":"string","description":"Unique identifier for the project object.","default":"PROJECT_NAME"},"config":{"type":"string","description":"Name of the branch config being cloned.","default":"CONFIG_NAME"},"name":{"type":"string","description":"Name of the new branch config.","default":"NEW_CONFIG_NAME"}}}}}},"responses":{"200":{"description":"200","content":{"application/json":{"examples":{"Result":{"value":"{\n  \"config\": {\n    \"name\": \"prd_aws\",\n    \"root\": false,\n    \"locked\": false,\n    \"initial_fetch_at\": \"2019-11-19T07:32:12.000Z\",\n    \"last_fetch_at\": \"2019-11-19T07:36:10.980Z\",\n    \"created_at\": \"2019-11-19T07:19:00.480Z\",\n    \"environment\": \"prd\",\n    \"project\": \"ed0c2a68b6\"\n  }\n}"}},"schema":{"type":"object","properties":{"config":{"type":"object","properties":{"name":{"type":"string","example":"prd_aws"},"root":{"type":"boolean","example":false,"default":true},"locked":{"type":"boolean","example":false,"default":true},"initial_fetch_at":{"type":"string","example":"2019-11-19T07:32:12.000Z"},"last_fetch_at":{"type":"string","example":"2019-11-19T07:36:10.980Z"},"created_at":{"type":"string","example":"2019-11-19T07:19:00.480Z"},"environment":{"type":"string","example":"prd"},"project":{"type":"string","example":"ed0c2a68b6"}}}}}}}}},"deprecated":false}},"/v3/configs/config/lock":{"post":{"summary":"Lock","description":"Prevent the config from being renamed or deleted.","operationId":"configs-lock","requestBody":{"content":{"application/json":{"schema":{"type":"object","required":["project","config"],"properties":{"project":{"type":"string","description":"Unique identifier for the project object.","default":"PROJECT_NAME"},"config":{"type":"string","description":"Name of the config.","default":"CONFIG_NAME"}}}}}},"responses":{"200":{"description":"200","content":{"application/json":{"examples":{"Result":{"value":"{\n  \"config\": {\n    \"name\": \"prd_aws\",\n    \"root\": false,\n    \"locked\": true,\n    \"initial_fetch_at\": \"2019-11-19T07:32:12.000Z\",\n    \"last_fetch_at\": \"2019-11-19T07:36:10.980Z\",\n    \"created_at\": \"2019-11-19T07:19:00.480Z\",\n    \"environment\": \"prd\",\n    \"project\": \"ed0c2a68b6\"\n  }\n}"}},"schema":{"type":"object","properties":{"config":{"type":"object","properties":{"name":{"type":"string","example":"prd_aws"},"root":{"type":"boolean","example":false,"default":true},"locked":{"type":"boolean","example":true,"default":true},"initial_fetch_at":{"type":"string","example":"2019-11-19T07:32:12.000Z"},"last_fetch_at":{"type":"string","example":"2019-11-19T07:36:10.980Z"},"created_at":{"type":"string","example":"2019-11-19T07:19:00.480Z"},"environment":{"type":"string","example":"prd"},"project":{"type":"string","example":"ed0c2a68b6"}}}}}}}}},"deprecated":false}},"/v3/configs/config/unlock":{"post":{"summary":"Unlock","description":"Allow the config to be renamed and/or deleted.","operationId":"configs-unlock","requestBody":{"content":{"application/json":{"schema":{"type":"object","required":["project","config"],"properties":{"project":{"type":"string","description":"Unique identifier for the project object.","default":"PROJECT_NAME"},"config":{"type":"string","description":"Name of the config.","default":"CONFIG_NAME"}}}}}},"responses":{"200":{"description":"200","content":{"application/json":{"examples":{"Result":{"value":"{\n  \"config\": {\n    \"name\": \"prd_aws\",\n    \"root\": false,\n    \"locked\": false,\n    \"initial_fetch_at\": \"2019-11-19T07:32:12.000Z\",\n    \"last_fetch_at\": \"2019-11-19T07:36:10.980Z\",\n    \"created_at\": \"2019-11-19T07:19:00.480Z\",\n    \"environment\": \"prd\",\n    \"project\": \"ed0c2a68b6\"\n  }\n}"}},"schema":{"type":"object","properties":{"config":{"type":"object","properties":{"name":{"type":"string","example":"prd_aws"},"root":{"type":"boolean","example":false,"default":true},"locked":{"type":"boolean","example":false,"default":true},"initial_fetch_at":{"type":"string","example":"2019-11-19T07:32:12.000Z"},"last_fetch_at":{"type":"string","example":"2019-11-19T07:36:10.980Z"},"created_at":{"type":"string","example":"2019-11-19T07:19:00.480Z"},"environment":{"type":"string","example":"prd"},"project":{"type":"string","example":"ed0c2a68b6"}}}}}}}}},"deprecated":false}},"/v3/configs/config/inheritable":{"post":{"summary":"Inheritable","description":"Update the inheritability of a config.","operationId":"configs-inheritable","requestBody":{"content":{"application/json":{"schema":{"type":"object","required":["project","config","inheritable"],"properties":{"project":{"type":"string","description":"Unique identifier for the project object.","default":"PROJECT_NAME"},"config":{"type":"string","description":"Name of the config.","default":"CONFIG_NAME"},"inheritable":{"type":"boolean","description":"Boolean determining if the config is inheritable or not.","default":false}}}}}},"responses":{"200":{"description":"200","content":{"application/json":{"examples":{"Result":{"value":"{\n  \"config\": {\n    \"name\": \"prd_gcp\",\n    \"root\": false,\n    \"inheritable\": true,\n    \"inheriting\": false,\n    \"inherits\": [],\n    \"inheritedBy\": [],\n    \"locked\": false,\n    \"initial_fetch_at\": \"2022-03-04T17:09:41.098Z\",\n    \"last_fetch_at\": \"2024-12-06T16:57:34.288Z\",\n    \"created_at\": \"2022-02-02T22:33:34.200Z\",\n    \"environment\": \"prd\",\n    \"project\": \"ed0c2a68b6\",\n    \"slug\": \"541bfc63-5c7f-4f68-88f7-ea1105dac98f\"\n  },\n  \"success\": true\n}"}},"schema":{"type":"object","properties":{"config":{"type":"object","properties":{"name":{"type":"string","example":"prd_gcp"},"root":{"type":"boolean","example":false,"default":true},"inheritable":{"type":"boolean","example":true,"default":true},"inheriting":{"type":"boolean","example":false,"default":true},"inherits":{"type":"array"},"inheritedBy":{"type":"array"},"locked":{"type":"boolean","example":false,"default":true},"initial_fetch_at":{"type":"string","example":"2022-03-04T17:09:41.098Z"},"last_fetch_at":{"type":"string","example":"2024-12-06T16:57:34.288Z"},"created_at":{"type":"string","example":"2022-02-02T22:33:34.200Z"},"environment":{"type":"string","example":"prd"},"project":{"type":"string","example":"ed0c2a68b6"},"slug":{"type":"string","example":"541bfc63-5c7f-4f68-88f7-ea1105dac98f"}}},"success":{"type":"boolean","example":true,"default":true}}}}}}},"deprecated":false}},"/v3/configs/config/inherits":{"post":{"summary":"Inherits","description":"","operationId":"configs-inherits","requestBody":{"content":{"application/json":{"schema":{"type":"object","required":["project","config","inherits"],"properties":{"project":{"type":"string","description":"Unique identifier for the project object of the config doing the inheriting.","default":"PROJECT_NAME"},"config":{"type":"string","description":"Name of the config object doing the inheriting.","default":"CONFIG_NAME"},"inherits":{"type":"array","description":"Array of objects indicating which configs are being inherited.","items":{"properties":{"project":{"type":"string","description":"Unique identifier for the project object of the config being inherited.","default":"PROJECT_NAME"},"config":{"type":"string","description":"Name of the config object being inherited.","default":"CONFIG_NAME"}},"required":["project","config"],"type":"object"}}}}}}},"responses":{"200":{"description":"200","content":{"application/json":{"examples":{"Result":{"value":"{\n  \"config\": {\n    \"name\": \"prd_gcp\",\n    \"root\": false,\n    \"inheritable\": false,\n    \"inheriting\": true,\n    \"inherits\": [\n      {\n        \"project\": \"project1\",\n        \"config\": \"dev\"\n      },\n      {\n        \"project\": \"project2\",\n        \"config\": \"dev\"\n      }\n    ],\n    \"inheritedBy\": [],\n    \"locked\": false,\n    \"initial_fetch_at\": \"2022-03-04T17:09:41.098Z\",\n    \"last_fetch_at\": \"2024-12-06T16:57:34.288Z\",\n    \"created_at\": \"2022-02-02T22:33:34.200Z\",\n    \"environment\": \"prd\",\n    \"project\": \"ed0c2a68b6\",\n    \"slug\": \"541bfc63-5c7f-4f68-88f7-ea1105dac98f\"\n  },\n  \"success\": true\n}"}},"schema":{"type":"object","properties":{"config":{"type":"object","properties":{"name":{"type":"string","example":"prd_gcp"},"root":{"type":"boolean","example":false,"default":true},"inheritable":{"type":"boolean","example":false,"default":true},"inheriting":{"type":"boolean","example":true,"default":true},"inherits":{"type":"array","items":{"type":"object","properties":{"project":{"type":"string","example":"project1"},"config":{"type":"string","example":"dev"}}}},"inheritedBy":{"type":"array"},"locked":{"type":"boolean","example":false,"default":true},"initial_fetch_at":{"type":"string","example":"2022-03-04T17:09:41.098Z"},"last_fetch_at":{"type":"string","example":"2024-12-06T16:57:34.288Z"},"created_at":{"type":"string","example":"2022-02-02T22:33:34.200Z"},"environment":{"type":"string","example":"prd"},"project":{"type":"string","example":"ed0c2a68b6"},"slug":{"type":"string","example":"541bfc63-5c7f-4f68-88f7-ea1105dac98f"}}},"success":{"type":"boolean","example":true,"default":true}}}}}}},"deprecated":false}},"/v3/configs/config/logs":{"get":{"summary":"List","description":"Config Logs","operationId":"config_logs-list","parameters":[{"name":"project","in":"query","description":"Unique identifier for the project object.","required":true,"schema":{"type":"string","default":"PROJECT_NAME"}},{"name":"config","in":"query","description":"Name of the config object.","required":true,"schema":{"type":"string","default":"CONFIG_NAME"}},{"name":"page","in":"query","description":"Page number","schema":{"type":"integer","format":"int32","default":1}},{"name":"per_page","in":"query","description":"Items per page","schema":{"type":"integer","format":"int32","default":20}}],"responses":{"200":{"description":"200","content":{"application/json":{"examples":{"Result":{"value":"{\n  \"page\": 1,\n  \"logs\": [\n    {\n      \"id\": \"WaRMMyxHUg4lOKR\",\n      \"text\": \"Defaults were updated which resulted in this config's secrets being modified\",\n      \"html\": \"Defaults were updated which resulted in this config's secrets being modified\",\n      \"rollback\": false,\n      \"created_at\": \"2019-11-19T07:19:01.073Z\",\n      \"config\": \"dev\",\n      \"environment\": \"dev\",\n      \"project\": \"ed0c2a68b6t\",\n      \"user\": {\n        \"email\": \"jake@piedpiper.com\",\n        \"name\": \"Jake Sun\",\n        \"username\": \"jake\",\n        \"profile_image_url\": \"https://www.gravatar.com/avatar/84da5be2b398382c676bfca6b38dae41?s=500&d=retro\"\n      }\n    }\n  ]\n}"}},"schema":{"type":"object","properties":{"page":{"type":"integer","example":1,"default":0},"logs":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","example":"WaRMMyxHUg4lOKR"},"text":{"type":"string","example":"Defaults were updated which resulted in this config's secrets being modified"},"html":{"type":"string","example":"Defaults were updated which resulted in this config's secrets being modified"},"rollback":{"type":"boolean","example":false,"default":true},"created_at":{"type":"string","example":"2019-11-19T07:19:01.073Z"},"config":{"type":"string","example":"dev"},"environment":{"type":"string","example":"dev"},"project":{"type":"string","example":"ed0c2a68b6t"},"user":{"type":"object","properties":{"email":{"type":"string","example":"jake@piedpiper.com"},"name":{"type":"string","example":"Jake Sun"},"username":{"type":"string","example":"jake"},"profile_image_url":{"type":"string","example":"https://www.gravatar.com/avatar/84da5be2b398382c676bfca6b38dae41?s=500&d=retro"}}}}}}}}}}}},"deprecated":false}},"/v3/configs/config/logs/log":{"get":{"summary":"Retrieve","description":"Config Log","operationId":"config_logs-get","parameters":[{"name":"project","in":"query","description":"Unique identifier for the project object.","required":true,"schema":{"type":"string","default":"PROJECT_NAME"}},{"name":"config","in":"query","description":"Name of the config object.","required":true,"schema":{"type":"string","default":"CONFIG_NAME"}},{"name":"log","in":"query","description":"Unique identifier for the log object.","required":true,"schema":{"type":"string","default":"LOG_ID"}}],"responses":{"200":{"description":"200","content":{"application/json":{"examples":{"Result":{"value":"{\n  \"log\": {\n    \"id\": \"WaRMMyxHUg4lOKR\",\n    \"text\": \"Defaults were updated which resulted in this config's secrets being modified\",\n    \"html\": \"Defaults were updated which resulted in this config's secrets being modified\",\n    \"diff\": [\n      {\n        \"name\": \"STRIPE\",\n        \"added\": \"sk_test_9YxLnoLDdvOPn2dfjBVPB\"\n      },\n      {\n        \"name\": \"ALGOLIA\",\n        \"added\": \"N9TOPUBTO\"\n      }\n    ],\n    \"rollback\": false,\n    \"created_at\": \"2019-11-19T07:19:01.073Z\",\n    \"config\": \"dev\",\n    \"environment\": \"dev\",\n    \"project\": \"ed0c2a68b6\",\n    \"user\": {\n      \"email\": \"jake@piedpiper.com\",\n      \"name\": \"Jake Sun\",\n      \"username\": \"jake\",\n      \"profile_image_url\": \"https://www.gravatar.com/avatar/84da5be2b398382c676bfca6b38dae41?s=500&d=retro\"\n    }\n  }\n}"}},"schema":{"type":"object","properties":{"log":{"type":"object","properties":{"id":{"type":"string","example":"WaRMMyxHUg4lOKR"},"text":{"type":"string","example":"Defaults were updated which resulted in this config's secrets being modified"},"html":{"type":"string","example":"Defaults were updated which resulted in this config's secrets being modified"},"diff":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","example":"STRIPE"},"added":{"type":"string","example":"sk_test_9YxLnoLDdvOPn2dfjBVPB"}}}},"rollback":{"type":"boolean","example":false,"default":true},"created_at":{"type":"string","example":"2019-11-19T07:19:01.073Z"},"config":{"type":"string","example":"dev"},"environment":{"type":"string","example":"dev"},"project":{"type":"string","example":"ed0c2a68b6"},"user":{"type":"object","properties":{"email":{"type":"string","example":"jake@piedpiper.com"},"name":{"type":"string","example":"Jake Sun"},"username":{"type":"string","example":"jake"},"profile_image_url":{"type":"string","example":"https://www.gravatar.com/avatar/84da5be2b398382c676bfca6b38dae41?s=500&d=retro"}}}}}}}}}}},"deprecated":false}},"/v3/configs/config/logs/log/rollback":{"post":{"summary":"Rollback","description":"Config Log","operationId":"config_logs-rollback","parameters":[{"name":"project","in":"query","description":"Unique identifier for the project object.","required":true,"schema":{"type":"string","default":"PROJECT_NAME"}},{"name":"config","in":"query","description":"Name of the config object.","required":true,"schema":{"type":"string","default":"CONFIG_NAME"}},{"name":"log","in":"query","description":"Unique identifier for the log object.","required":true,"schema":{"type":"string","default":"LOG_ID"}}],"responses":{"200":{"description":"200","content":{"application/json":{"examples":{"Result":{"value":"{\n  \"log\": {\n    \"id\": \"koVGA1cgzkFnTHx\",\n    \"text\": \"Rolled back log WaRMMyxHUg4lOKR\",\n    \"html\": \"Rolled back log <a  href='https://doppler.internal:3030/workplace/2ada3/enclave/484/configs/2026/logs?id=WaRMMyxHUg4lOKR'>WaRMMyxHUg4lOKR</a>\",\n    \"diff\": [\n      {\n        \"name\": \"STRIPE\",\n        \"removed\": \"sk_test_9YxLnoLDdvOPn2dfjBVPB\"\n      },\n      {\n        \"name\": \"ALGOLIA\",\n        \"removed\": \"N9TOPUBTO\"\n      }\n    ],\n    \"rollback\": true,\n    \"created_at\": \"2019-11-24T02:25:54.761Z\",\n    \"config\": \"dev\",\n    \"environment\": \"dev\",\n    \"project\": \"ed0c2a68b6\",\n    \"user\": {\n      \"email\": \"jake@piedpiper.com\",\n      \"name\": \"Jake Sun\",\n      \"username\": \"jake\",\n      \"profile_image_url\": \"https://www.gravatar.com/avatar/84da5be2b398382c676bfca6b38dae41?s=500&d=retro\"\n    }\n  }\n}"}},"schema":{"type":"object","properties":{"log":{"type":"object","properties":{"id":{"type":"string","example":"koVGA1cgzkFnTHx"},"text":{"type":"string","example":"Rolled back log WaRMMyxHUg4lOKR"},"html":{"type":"string","example":"Rolled back log <a  href='https://doppler.internal:3030/workplace/2ada3/enclave/484/configs/2026/logs?id=WaRMMyxHUg4lOKR'>WaRMMyxHUg4lOKR</a>"},"diff":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","example":"STRIPE"},"removed":{"type":"string","example":"sk_test_9YxLnoLDdvOPn2dfjBVPB"}}}},"rollback":{"type":"boolean","example":true,"default":true},"created_at":{"type":"string","example":"2019-11-24T02:25:54.761Z"},"config":{"type":"string","example":"dev"},"environment":{"type":"string","example":"dev"},"project":{"type":"string","example":"ed0c2a68b6"},"user":{"type":"object","properties":{"email":{"type":"string","example":"jake@piedpiper.com"},"name":{"type":"string","example":"Jake Sun"},"username":{"type":"string","example":"jake"},"profile_image_url":{"type":"string","example":"https://www.gravatar.com/avatar/84da5be2b398382c676bfca6b38dae41?s=500&d=retro"}}}}}}}}}}},"deprecated":false}},"/v3/configs/config/trusted_ips":{"get":{"summary":"List","description":"","operationId":"configs-list_trusted_ips","parameters":[{"name":"project","in":"query","required":true,"schema":{"type":"string"}},{"name":"config","in":"query","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"200","content":{"application/json":{"examples":{"Result":{"value":"{\n  \"ips\": [\n  \t\"0.0.0.0/0\"\n  ]\n}"}},"schema":{"type":"object","properties":{"ips":{"type":"array","items":{"type":"string","example":"0.0.0.0/0"}}}}}}}},"deprecated":false},"post":{"summary":"Add","description":"","operationId":"configs-add_trusted_ip","parameters":[{"name":"project","in":"query","required":true,"schema":{"type":"string"}},{"name":"config","in":"query","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","required":["ip"],"properties":{"ip":{"type":"string","description":"An IP address or CIDR range"}}}}}},"responses":{"200":{"description":"200","content":{"application/json":{"examples":{"IP added":{"value":"{\n  \"ip\": \"0.0.0.0/0\"\n}"}},"schema":{"type":"object","properties":{"ip":{"type":"string","example":"0.0.0.0/0"}}}}}},"204":{"description":"204","content":{"application/json":{"examples":{"IP exists":{"value":""}}}}}},"deprecated":false},"delete":{"summary":"Delete","description":"","operationId":"configs-delete_trusted_ip","parameters":[{"name":"project","in":"query","required":true,"schema":{"type":"string"}},{"name":"config","in":"query","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","required":["ip"],"properties":{"ip":{"type":"string","description":"An IP address or CIDR range"}}}}}},"responses":{"204":{"description":"204","content":{"application/json":{"examples":{"Result":{"value":""}}}}},"404":{"description":"404","content":{"text/plain":{"examples":{"Result":{"value":""}}}}}},"deprecated":false}},"/v3/configs/config/secrets":{"get":{"summary":"List","description":"Secrets","operationId":"secrets-list","parameters":[{"name":"project","in":"query","description":"Unique identifier for the project object.","required":true,"schema":{"type":"string","default":"PROJECT_NAME"}},{"name":"config","in":"query","description":"Name of the config object.","required":true,"schema":{"type":"string","default":"CONFIG_NAME"}},{"name":"accepts","in":"header","description":"Available options are: **application/json**, **text/plain**","schema":{"type":"string","default":"application/json"}},{"name":"include_dynamic_secrets","in":"query","description":"Whether or not to issue leases and include dynamic secret values for the config","schema":{"type":"boolean","default":false}},{"name":"dynamic_secrets_ttl_sec","in":"query","description":"The number of seconds until dynamic leases expire. Must be used with `include_dynamic_secrets`. Defaults to 1800 (30 minutes).","schema":{"type":"integer","format":"int32"}},{"name":"secrets","in":"query","description":"A comma-separated list of secrets to include in the response","schema":{"type":"string"}},{"name":"include_managed_secrets","in":"query","description":"Whether to include Doppler's auto-generated (managed) secrets","schema":{"type":"boolean","default":true}}],"responses":{"200":{"description":"200","content":{"application/json":{"examples":{"Result":{"value":{"secrets":{"STRIPE":{"raw":"sk_test_9YxLnoLDdvOPn2dfjBVPB","computed":"sk_test_9YxLnoLDdvOPn2dfjBVPB","note":"","rawVisibility":{"type":"masked"},"computedVisibility":{"type":"masked"}},"ALGOLIA":{"raw":"N9TOPUCTO","computed":"N9TOPUCTO","note":"","rawVisibility":{"type":"masked"},"computedVisibility":{"type":"masked"}},"DATABASE":{"raw":"${USER}@aws.dynamodb.com:9876","computed":"brian@aws.dynamodb.com:9876","note":"","rawVisibility":{"type":"restricted"},"computedVisibility":{"type":"restricted"}},"USER":{"raw":"brian","computed":"brian","note":"","rawVisibility":{"type":"unmasked"},"computedVisibility":{"type":"unmasked"}}}}}},"schema":{"type":"object","properties":{"secrets":{"type":"object","properties":{"STRIPE":{"type":"object","properties":{"raw":{"type":"string","example":"sk_test_9YxLnoLDdvOPn2dfjBVPB"},"computed":{"type":"string","example":"sk_test_9YxLnoLDdvOPn2dfjBVPB"},"note":{"type":"string","example":""},"rawVisibility":{"type":"object","example":"masked","properties":{"type":{"type":"string"}}},"computedVisibility":{"type":"object","example":"masked","properties":{"type":{"type":"string"}}}}},"ALGOLIA":{"type":"object","properties":{"raw":{"type":"string","example":"N9TOPUCTO"},"computed":{"type":"string","example":"N9TOPUCTO"},"note":{"type":"string","example":""},"rawVisibility":{"type":"object","example":"masked","properties":{"type":{"type":"string"}}},"computedVisibility":{"type":"object","example":"masked","properties":{"type":{"type":"string"}}}}},"DATABASE":{"type":"object","properties":{"raw":{"type":"string","example":"${USER}@aws.dynamodb.com:9876"},"computed":{"type":"string","example":"brian@aws.dynamodb.com:9876"},"note":{"type":"string","example":""},"rawVisibility":{"type":"object","example":"restricted","properties":{"type":{"type":"string"}}},"computedVisibility":{"type":"object","example":"restricted","properties":{"type":{"type":"string"}}}}},"USER":{"type":"object","properties":{"raw":{"type":"string","example":"brian"},"computed":{"type":"string","example":"brian"},"note":{"type":"string","example":""},"rawVisibility":{"type":"object","example":"unmasked","properties":{"type":{"type":"string"}}},"computedVisibility":{"type":"object","example":"unmasked","properties":{"type":{"type":"string"}}}}}}}}}}}}}},"post":{"summary":"Update","description":"Secrets","operationId":"secrets-update","requestBody":{"content":{"application/json":{"schema":{"type":"object","required":["project","config"],"properties":{"project":{"type":"string","description":"Unique identifier for the project object.","default":"PROJECT_NAME"},"config":{"type":"string","description":"Name of the config object.","default":"CONFIG_NAME"},"secrets":{"type":"object","description":"Either `secrets` or `change_requests` is required (can't use both). Object of secrets you would like to save to the config. Try it with the sample secrets below.","properties":{"STRIPE":{"type":"string","default":"sk_test_9YxLnoLDdvOPn2dfjBVPB"},"ALGOLIA":{"type":"string","default":"N9TOPUCTO"},"DATABASE":{"type":"string","default":"${USER}@aws.dynamodb.com:9876"}}},"change_requests":{"type":"array","description":"Either `secrets` or `change_requests` is required (can't use both). Object of secrets you would like to save to the config. Try it with the sample secrets below.","items":{"properties":{"name":{"type":"string","description":"The name of the secret."},"originalName":{"type":"string","description":"The original name of the secret. Use `null` (an actual `null`, not the string `null`) or omit this parameter for new secrets. If it differs from `name` then a rename is inferred."},"value":{"type":"string","description":"The value the secret should have. Use `null` (an actual `null`, not the string `null`) to leave the existing secret value unchanged."},"originalValue":{"type":"string","description":"The value you expect the secret to have before `name` is applied. If specified, the request will only be processed if the provided value matches what's found in Doppler."},"visibility":{"type":"string","description":"Must be set to either `masked`, `unmasked`, or `restricted`."},"originalVisibility":{"type":"string","description":"Must be set to either `masked`, `unmasked`, or `restricted`. The visibility you expect the secret to have before `visibility` is applied. If specified, the request will only be processed if the provided visibility matches what's found in Doppler."},"shouldPromote":{"type":"boolean","description":"Defaults to `false`. Can only be set to `true` if the config being updated is a branch config. If set to `true`, the provided secret will be set in both the branch config as well as the root config in that environment."},"shouldDelete":{"type":"boolean","description":"Defaults to `false`. If set to `true`, will delete the secret matching the `name` field."},"shouldConverge":{"type":"boolean","description":"Defaults to `false`. Can only be set to `true` if the config being updated is a branch config and there is a secret with the same name in the root config. In this case, the branch secret will inherit the value and visibility type from the root secret."},"valueType":{"type":"object","description":"The default valueType (string) will result in no validations being applied.","properties":{"type":{"type":"string","enum":["string","json","json5","boolean","integer","decimal","email","url","uuidv4","cuid2","ulid","datetime8601","date8601","yaml"]}}},"originalValueType":{"type":"object","description":"The valueType you expect the secret to have before `valueType` is applied. If specified, the request will only be processed if the provided valueType matches what's found in Doppler.","properties":{"type":{"type":"string","enum":["string","json","json5","boolean","integer","decimal","email","url","uuidv4","cuid2","ulid","datetime8601","date8601","yaml"]}}}},"required":["name","originalName","value"],"type":"object"}}}}}}},"responses":{"200":{"description":"200","content":{"application/json":{"examples":{"Result":{"value":"{\n  \"secrets\": {\n    \"STRIPE\": {\n      \"raw\": \"sk_test_9YxLnoLDdvOPn2dfjBVPB\",\n      \"computed\": \"sk_test_9YxLnoLDdvOPn2dfjBVPB\",\n      \"note\": \"\"\n    },\n    \"ALGOLIA\": {\n      \"raw\": \"N9TOPUCTO\",\n      \"computed\": \"N9TOPUCTO\",\n      \"note\": \"\"\n    },\n    \"DATABASE\": {\n    \t\"raw\": \"${USER}@aws.dynamodb.com:9876\",\n      \"computed\": \"brian@aws.dynamodb.com:9876\",\n      \"note\": \"\"\n    }\n  }\n}"}},"schema":{"type":"object","properties":{"secrets":{"type":"object","properties":{"STRIPE":{"type":"object","properties":{"raw":{"type":"string","example":"sk_test_9YxLnoLDdvOPn2dfjBVPB"},"computed":{"type":"string","example":"sk_test_9YxLnoLDdvOPn2dfjBVPB"},"note":{"type":"string","example":""}}},"ALGOLIA":{"type":"object","properties":{"raw":{"type":"string","example":"N9TOPUCTO"},"computed":{"type":"string","example":"N9TOPUCTO"},"note":{"type":"string","example":""}}},"DATABASE":{"type":"object","properties":{"raw":{"type":"string","example":"${USER}@aws.dynamodb.com:9876"},"computed":{"type":"string","example":"brian@aws.dynamodb.com:9876"},"note":{"type":"string","example":""}}}}}}}}}}},"deprecated":false}},"/v3/configs/config/secret":{"get":{"summary":"Retrieve","description":"Secret","operationId":"secrets-get","parameters":[{"name":"project","in":"query","description":"Unique identifier for the project object.","required":true,"schema":{"type":"string","default":"PROJECT_NAME"}},{"name":"config","in":"query","description":"Name of the config object.","required":true,"schema":{"type":"string","default":"CONFIG_NAME"}},{"name":"name","in":"query","description":"Name of the secret.","required":true,"schema":{"type":"string","default":"SECRET_NAME"}}],"responses":{"200":{"description":"200","content":{"application/json":{"examples":{"Result":{"value":"{\n  \"name\": \"DATABASE\",\n  \"value\": {\n    \"raw\": \"${USER}@aws.dynamodb.com:9876\",\n    \"computed\": \"brian@aws.dynamodb.com:9876\",\n    \"note\": \"\"\n  }\n}"}},"schema":{"type":"object","properties":{"name":{"type":"string","example":"DATABASE"},"value":{"type":"object","properties":{"raw":{"type":"string","example":"${USER}@aws.dynamodb.com:9876"},"computed":{"type":"string","example":"brian@aws.dynamodb.com:9876"},"note":{"type":"string","example":""},"rawVisibility":{"type":"string","enum":["unmasked","masked","restricted"]},"computedVisibility":{"type":"string"},"rawValueType":{"type":"object","properties":{"type":{"type":"string"}}},"computedValueType":{"type":"object","properties":{"type":{"type":"string"}}}}}}}}}}}},"delete":{"summary":"Delete","description":"Secret","operationId":"secrets-delete","parameters":[{"name":"project","in":"query","description":"Unique identifier for the project object.","required":true,"schema":{"type":"string","default":"PROJECT_NAME"}},{"name":"config","in":"query","description":"Name of the config object.","required":true,"schema":{"type":"string","default":"CONFIG_NAME"}},{"name":"name","in":"query","description":"Name of the secret.","required":true,"schema":{"type":"string","default":"SECRET_NAME"}}],"responses":{"204":{"description":"204","content":{"application/json":{"examples":{"Result":{"value":""}}}}}},"deprecated":false}},"/v3/configs/config/secrets/download":{"get":{"summary":"Download","description":"Download Secrets","operationId":"secrets-download","parameters":[{"name":"project","in":"query","description":"Unique identifier for the project object. Not required if using a Service Token.","required":true,"schema":{"type":"string"}},{"name":"config","in":"query","description":"Name of the config object. Not required if using a Service Token.","required":true,"schema":{"type":"string"}},{"name":"format","in":"query","schema":{"type":"string","enum":["json","dotnet-json","env","yaml","docker","env-no-quotes"],"default":"json"}},{"name":"name_transformer","in":"query","description":"Transform secret names to a different case","schema":{"type":"string","enum":["camel","upper-camel","lower-snake","tf-var","dotnet","dotnet-env","lower-kebab"]}},{"name":"include_dynamic_secrets","in":"query","description":"Whether or not to issue leases and include dynamic secret values for the config","schema":{"type":"boolean","default":false}},{"name":"dynamic_secrets_ttl_sec","in":"query","description":"The number of seconds until dynamic leases expire. Must be used with `include_dynamic_secrets`. Defaults to 1800 (30 minutes).","schema":{"type":"integer","format":"int32","default":1800}},{"name":"secrets","in":"query","description":"Comma-delimited list of secrets to include in the download. Defaults to all secrets if left unspecified.","schema":{"type":"string"}}],"responses":{"200":{"description":"200","content":{"application/json":{"examples":{"Result":{"value":"{\n  \"STRIPE\": \"sk_test_9YxLnoLDdvOPn2dfjBVPB\",\n  \"ALGOLIA\": \"N9TOPUCTO\",\n  \"DATABASE\": \"brian@aws.dynamodb.com:9876\",\n  \"USER\": \"brian\"\n}"}},"schema":{"type":"object","properties":{"STRIPE":{"type":"string","example":"sk_test_9YxLnoLDdvOPn2dfjBVPB"},"ALGOLIA":{"type":"string","example":"N9TOPUCTO"},"DATABASE":{"type":"string","example":"brian@aws.dynamodb.com:9876"},"USER":{"type":"string","example":"brian"}}}}}}},"deprecated":false}},"/v3/configs/config/secrets/names":{"get":{"summary":"List Names","description":"Secret Names","operationId":"secrets-names","parameters":[{"name":"project","in":"query","description":"Unique identifier for the project object.","required":true,"schema":{"type":"string","default":"PROJECT_NAME"}},{"name":"config","in":"query","description":"Name of the config object.","required":true,"schema":{"type":"string","default":"CONFIG_NAME"}},{"name":"include_dynamic_secrets","in":"query","description":"Whether or not to issue leases and include dynamic secret values for the config","schema":{"type":"boolean","default":false}},{"name":"include_managed_secrets","in":"query","description":"Whether to include Doppler's auto-generated (managed) secrets","schema":{"type":"boolean","default":true}}],"responses":{"200":{"description":"200","content":{"application/json":{"examples":{"Result":{"value":"{\n  \"names\": [\n    \"STRIPE\",\n    \"ALGOLIA\",\n    \"DATABASE\",\n    \"USER\"\n  ]\n}"}},"schema":{"type":"object","properties":{"names":{"type":"array","items":{"type":"string","example":"STRIPE"}}}}}}}},"deprecated":false}},"/v3/projects/project/note":{"post":{"summary":"Update Note","description":"Set a note on a secret","operationId":"secrets-update_note","parameters":[{"name":"project","in":"query","description":"Unique identifier for the project object.","schema":{"type":"string","default":"PROJECT_NAME"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","required":["secret","note"],"properties":{"secret":{"type":"string","description":"The name of the secret","default":"SECRET_NAME"},"note":{"type":"string","description":"The note you want to set on the secret. This note will be applied to the specified secret in all environments.","default":"YOUR_NOTE"}}}}}},"responses":{"200":{"description":"200","content":{"application/json":{"examples":{"Result":{"value":"{\n  \"secret\": \"FOO\",\n  \"note\": \"bar\"\n}"}},"schema":{"type":"object","properties":{"secret":{"type":"string","example":"FOO"},"note":{"type":"string","example":"bar"}}}}}}},"deprecated":false}},"/v3/integrations":{"get":{"summary":"List","description":"List all existing integrations","operationId":"integrations-list","responses":{"200":{"description":"200","content":{"application/json":{"examples":{"Result":{"value":"{\n  \"integrations\": [\n    {\n      \"slug\": \"e32d0dcd-c094-4606-aefa-c4127e2a1282\",\n      \"name\": \"Cloudflare Integration\",\n      \"type\": \"cloudflare_tokens\",\n      \"kind\": \"rotatedSecrets\",\n      \"enabled\": true\n    },\n    {\n      \"slug\": \"0cd84923-b8c5-49e6-8713-e6ea2148a6c1\",\n      \"name\": \"Doppler University\",\n      \"type\": \"qovery\",\n      \"kind\": \"sync\",\n      \"enabled\": true,\n      \"syncs\": [\n        {\n          \"slug\": \"96e9647b-f114-4cf8-adf7-adee91b9f8c7\",\n          \"enabled\": true,\n          \"lastSyncedAt\": \"2023-05-12T19:08:17.089Z\",\n          \"project\": \"backend\",\n          \"config\": \"prd\",\n          \"integration\": \"0cd84923-b8c5-49e6-8713-e6ea2148a6c1\"\n        }\n      ]\n    },\n    {\n      \"slug\": \"836cf9fd-11b8-46a7-b0c6-730865b95263\",\n      \"name\": \"Doppler University\",\n      \"type\": \"railway\",\n      \"kind\": \"sync\",\n      \"enabled\": true,\n      \"syncs\": []\n    }\n  ],\n  \"success\": true\n}"}},"schema":{"type":"object","properties":{"integrations":{"type":"array","items":{"type":"object","properties":{"slug":{"type":"string","example":"e32d0dcd-c094-4606-aefa-c4127e2a1282"},"name":{"type":"string","example":"Cloudflare Integration"},"type":{"type":"string","example":"cloudflare_tokens"},"kind":{"type":"string","example":"rotatedSecrets"},"enabled":{"type":"boolean","example":true,"default":true}}}},"success":{"type":"boolean","example":true,"default":true}}}}}}},"deprecated":false},"post":{"summary":"Create","description":"Create a new external integration.","operationId":"integrations-create","requestBody":{"content":{"application/json":{"schema":{"type":"object","required":["type","name"],"properties":{"type":{"type":"string","description":"The integration type"},"name":{"type":"string","description":"The name of the integration"},"data":{"type":"object","description":"The authentication data for the integration","properties":{}}}}}}},"responses":{"200":{"description":"200","content":{"application/json":{"examples":{"Result":{"value":"{\n  \"integration\": {\n    \"slug\": \"00000000-0000-0000-0000-000000000000\",\n    \"name\": \"my-integration\",\n    \"type\": \"gcp_secret_manager\",\n    \"federation\": {\n      \"kind\": \"gcp\",\n      \"principal\": \"principal://iam.googleapis.com/projects/123456789012/locations/global/workloadIdentityPools/doppler/subject/workplace:my-workplace:connection:00000000-0000-0000-0000-000000000000\"\n    }\n  }\n}"}},"schema":{"type":"object","properties":{"integration":{"type":"object","properties":{"slug":{"type":"string","example":"00000000-0000-0000-0000-000000000000"},"name":{"type":"string","example":"my-integration"},"type":{"type":"string","example":"aws"},"federation":{"description":"The keyless federation identity Doppler presents to your cloud, or null if this connection does not use keyless authentication. Grant this identity access after creating the connection.","oneOf":[{"type":"object","title":"GCP","properties":{"kind":{"type":"string","const":"gcp"},"principal":{"type":"string","description":"The IAM principal to grant roles to.","example":"principal://iam.googleapis.com/projects/123456789012/locations/global/workloadIdentityPools/doppler/subject/workplace:my-workplace:connection:00000000-0000-0000-0000-000000000000"}},"required":["kind","principal"]},{"type":"object","title":"Azure","properties":{"kind":{"type":"string","const":"azure"},"issuer":{"type":"string","description":"The issuer to enter on the app registration's federated credential.","example":"https://api.doppler.com"},"subject":{"type":"string","description":"The subject identifier to enter on the federated credential.","example":"workplace:my-workplace:connection:00000000-0000-0000-0000-000000000000"},"audience":{"type":"string","description":"The audience to enter on the federated credential.","example":"api://AzureADTokenExchange"}},"required":["kind","issuer","subject","audience"]},{"type":"null"}]}}}}}}}},"400":{"description":"400","content":{"application/json":{"examples":{"Result":{"value":"{}"}},"schema":{"type":"object","properties":{}}}}}},"deprecated":false}},"/v3/integrations/integration":{"get":{"summary":"Retrieve","description":"Retrieve an existing integration","operationId":"integrations-get","parameters":[{"name":"integration","in":"query","description":"The integration slug","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"200","content":{"application/json":{"examples":{"Result":{"value":"{\n  \"integration\": {\n    \"slug\": \"00000000-0000-0000-0000-000000000000\",\n    \"name\": \"my-integration\",\n    \"type\": \"gcp_secret_manager\",\n    \"federation\": {\n      \"kind\": \"gcp\",\n      \"principal\": \"principal://iam.googleapis.com/projects/123456789012/locations/global/workloadIdentityPools/doppler/subject/workplace:my-workplace:connection:00000000-0000-0000-0000-000000000000\"\n    }\n  }\n}"}},"schema":{"type":"object","properties":{"integration":{"type":"object","properties":{"slug":{"type":"string","example":"00000000-0000-0000-0000-000000000000"},"name":{"type":"string","example":"my-integration"},"type":{"type":"string","example":"aws"},"federation":{"description":"The keyless federation identity Doppler presents to your cloud, or null if this connection does not use keyless authentication. Grant this identity access after creating the connection.","oneOf":[{"type":"object","title":"GCP","properties":{"kind":{"type":"string","const":"gcp"},"principal":{"type":"string","description":"The IAM principal to grant roles to.","example":"principal://iam.googleapis.com/projects/123456789012/locations/global/workloadIdentityPools/doppler/subject/workplace:my-workplace:connection:00000000-0000-0000-0000-000000000000"}},"required":["kind","principal"]},{"type":"object","title":"Azure","properties":{"kind":{"type":"string","const":"azure"},"issuer":{"type":"string","description":"The issuer to enter on the app registration's federated credential.","example":"https://api.doppler.com"},"subject":{"type":"string","description":"The subject identifier to enter on the federated credential.","example":"workplace:my-workplace:connection:00000000-0000-0000-0000-000000000000"},"audience":{"type":"string","description":"The audience to enter on the federated credential.","example":"api://AzureADTokenExchange"}},"required":["kind","issuer","subject","audience"]},{"type":"null"}]}}}}}}}},"400":{"description":"400","content":{"application/json":{"examples":{"Result":{"value":"{}"}},"schema":{"type":"object","properties":{}}}}}},"deprecated":false},"put":{"summary":"Update","description":"Update an existing integration.","operationId":"integrations-update","parameters":[{"name":"integration","in":"query","description":"The slug of the integration to update","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","description":"The new name of the integration"},"data":{"type":"string","description":"The new authentication data for the integration"}}}}}},"responses":{"200":{"description":"200","content":{"application/json":{"examples":{"Result":{"value":"{}"}},"schema":{"type":"object","properties":{}}}}},"400":{"description":"400","content":{"application/json":{"examples":{"Result":{"value":"{}"}},"schema":{"type":"object","properties":{}}}}}},"deprecated":false},"delete":{"summary":"Delete","description":"Delete an existing integration.","operationId":"integrations-delete","parameters":[{"name":"integration","in":"query","description":"The slug of the integration to delete","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"200","content":{"application/json":{"examples":{"Result":{"value":"{}"}},"schema":{"type":"object","properties":{}}}}},"400":{"description":"400","content":{"application/json":{"examples":{"Result":{"value":"{}"}},"schema":{"type":"object","properties":{}}}}}},"deprecated":false}},"/v3/integrations/integration/options":{"get":{"summary":"Get Options","description":"","operationId":"get-options","parameters":[{"name":"integration","in":"query","description":"The integration slug","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"200","content":{"application/json":{"examples":{"Result":{"value":"{}"}},"schema":{"type":"object","properties":{}}}}},"400":{"description":"400","content":{"application/json":{"examples":{"Result":{"value":"{}"}},"schema":{"type":"object","properties":{}}}}}},"deprecated":false}},"/v3/configs/config/syncs":{"post":{"summary":"Create","description":"Create a new secrets sync.","operationId":"syncs-create","parameters":[{"name":"project","in":"query","description":"The project slug","required":true,"schema":{"type":"string"}},{"name":"config","in":"query","description":"The config slug","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","required":["integration","data"],"properties":{"integration":{"type":"string","description":"The integration slug which the sync will use"},"data":{"type":"object","description":"Configuration data for the sync","properties":{}},"import_option":{"type":"string","description":"An option indicating if and how Doppler should attempt to import secrets from the sync destination","default":"none","enum":["none","prefer_doppler","prefer_integration"]},"await_initial_sync":{"type":"boolean","description":"Causes sync creation to wait for the initial sync to complete before returning.","default":false}}}}}},"responses":{"200":{"description":"200","content":{"application/json":{"examples":{"Result":{"value":"{\n\t\"sync\": {\n  \t\"slug\": \"00000000-0000-0000-0000-000000000000\",\n  \t\"integration\": \"00000000-0000-0000-0000-000000000000\",\n    \"project\": \"backend\",\n    \"config\": \"prd\",\n    \"enabled\": true,\n    \"lastSyncedAt\": \"2023-08-01T00:00:00.000Z\"\n  }\n}"}},"schema":{"type":"object","properties":{"sync":{"type":"object","properties":{"slug":{"type":"string","example":"00000000-0000-0000-0000-000000000000"},"integration":{"type":"string","example":"00000000-0000-0000-0000-000000000000"},"project":{"type":"string","example":"backend"},"config":{"type":"string","example":"prd"},"enabled":{"type":"boolean","example":true,"default":true},"lastSyncedAt":{"type":"string","example":"2023-08-01T00:00:00.000Z"}}}}}}}},"400":{"description":"400","content":{"application/json":{"examples":{"Result":{"value":"{}"}},"schema":{"type":"object","properties":{}}}}}},"deprecated":false}},"/v3/configs/config/syncs/sync":{"get":{"summary":"Retrieve","description":"Retrieve an existing secrets sync.","operationId":"syncs-get","parameters":[{"name":"project","in":"query","description":"The project slug","required":true,"schema":{"type":"string"}},{"name":"config","in":"query","description":"The config slug","required":true,"schema":{"type":"string"}},{"name":"sync","in":"query","description":"The sync slug","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"200","content":{"application/json":{"examples":{"Result":{"value":"{\n\t\"sync\": {\n  \t\"slug\": \"00000000-0000-0000-0000-000000000000\",\n  \t\"integration\": \"00000000-0000-0000-0000-000000000000\",\n    \"project\": \"backend\",\n    \"config\": \"prd\",\n    \"enabled\": true,\n    \"lastSyncedAt\": \"2023-08-01T00:00:00.000Z\"\n  }\n}"}},"schema":{"type":"object","properties":{"sync":{"type":"object","properties":{"slug":{"type":"string","example":"00000000-0000-0000-0000-000000000000"},"integration":{"type":"string","example":"00000000-0000-0000-0000-000000000000"},"project":{"type":"string","example":"backend"},"config":{"type":"string","example":"prd"},"enabled":{"type":"boolean","example":true,"default":true},"lastSyncedAt":{"type":"string","example":"2023-08-01T00:00:00.000Z"}}}}}}}},"400":{"description":"400","content":{"application/json":{"examples":{"Result":{"value":"{}"}},"schema":{"type":"object","properties":{}}}}}},"deprecated":false},"delete":{"summary":"Delete","description":"Delete an existing sync.","operationId":"syncs-delete","parameters":[{"name":"project","in":"query","description":"The project slug","required":true,"schema":{"type":"string"}},{"name":"config","in":"query","description":"The config slug","required":true,"schema":{"type":"string"}},{"name":"sync","in":"query","description":"The sync slug","required":true,"schema":{"type":"string"}},{"name":"delete_from_target","in":"query","description":"Whether or not to delete the synced data from the target integration","required":true,"schema":{"type":"boolean"}}],"responses":{"200":{"description":"200","content":{"application/json":{"examples":{"Result":{"value":"{}"}},"schema":{"type":"object","properties":{}}}}},"400":{"description":"400","content":{"application/json":{"examples":{"Result":{"value":"{}"}},"schema":{"type":"object","properties":{}}}}}},"deprecated":false}},"/v3/configs/config/dynamic_secrets/dynamic_secret/leases":{"post":{"summary":"Issue Lease","description":"Issue a lease for a dynamic secret","operationId":"dynamic_secrets-issue_lease","requestBody":{"content":{"application/json":{"schema":{"type":"object","required":["project","config","dynamic_secret","ttl_sec"],"properties":{"project":{"type":"string","description":"The project where the dynamic secret is located"},"config":{"type":"string","description":"The config where the dynamic secret is located"},"dynamic_secret":{"type":"string","description":"The name of the dynamic secret for which to issue this lease"},"ttl_sec":{"type":"integer","description":"The number of seconds until this lease is automatically revoked","format":"int32"}}}}}},"responses":{"200":{"description":"200","content":{"application/json":{"examples":{"Result":{"value":"{\n    \"success\": true,\n    \"id\": \"59ed03c9-63a7-4789-9187-a3d858355353\",\n    \"expires_at\": \"2022-02-18T20:36:28.427Z\",\n    \"value\": {  }\n}"}},"schema":{"type":"object","properties":{"success":{"type":"boolean","example":true,"default":true},"id":{"type":"string","example":"59ed03c9-63a7-4789-9187-a3d858355353"},"expires_at":{"type":"string","example":"2022-02-18T20:36:28.427Z"},"value":{"type":"object","properties":{}}}}}}}},"deprecated":false}},"/v3/configs/config/dynamic_secrets/dynamic_secret/leases/lease":{"delete":{"summary":"Revoke Lease","description":"","operationId":"dynamic_secrets-revoke_lease","requestBody":{"content":{"application/json":{"schema":{"type":"object","required":["project","config","dynamic_secret","slug"],"properties":{"project":{"type":"string","description":"The project where the dynamic secret is located"},"config":{"type":"string","description":"The config where the dynamic secret is located"},"dynamic_secret":{"type":"string","description":"The name of the dynamic secret from which this lease was issued"},"slug":{"type":"string","description":"The slug of the lease to revoke"}}}}}},"responses":{"200":{"description":"200","content":{"application/json":{"examples":{"Result":{"value":"{ \"success\": true }"}},"schema":{"type":"object","properties":{"success":{"type":"boolean","example":true,"default":true}}}}}}},"deprecated":false}},"/v3/configs/config/tokens":{"get":{"summary":"List","description":"Service Tokens","operationId":"service_tokens-list","parameters":[{"name":"project","in":"query","description":"Unique identifier for the project object.","required":true,"schema":{"type":"string","default":"PROJECT_NAME"}},{"name":"config","in":"query","description":"Name of the config object.","required":true,"schema":{"type":"string","default":"CONFIG_NAME"}}],"responses":{"200":{"description":"200","content":{"application/json":{"examples":{"Result":{"value":"{\n  \"tokens\": [\n    {\n      \"name\": \"AWS Lambda\",\n      \"slug\": \"56c69f96-3045-11ea-978f-2e728ce88125\",\n      \"created_at\": \"2019-11-19T07:19:01.073Z\",\n      \"config\": \"dev\",\n      \"environment\": \"dev\",\n      \"project\": \"ed0c2a68b6t\",\n      \"expires_at\": null\n    }\n  ]\n}"}},"schema":{"type":"object","properties":{"tokens":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","example":"AWS Lambda"},"slug":{"type":"string","example":"56c69f96-3045-11ea-978f-2e728ce88125"},"created_at":{"type":"string","example":"2019-11-19T07:19:01.073Z"},"config":{"type":"string","example":"dev"},"environment":{"type":"string","example":"dev"},"project":{"type":"string","example":"ed0c2a68b6t"},"expires_at":{}}}}}}}}}},"deprecated":false},"post":{"summary":"Create","description":"Service Token","operationId":"service_tokens-create","requestBody":{"content":{"application/json":{"schema":{"type":"object","required":["project","config","name"],"properties":{"project":{"type":"string","description":"Unique identifier for the project object.","default":"PROJECT_NAME"},"config":{"type":"string","description":"Name of the config object.","default":"CONFIG_NAME"},"name":{"type":"string","description":"Name of the service token.","default":"TOKEN_NAME"},"expire_at":{"type":"string","description":"Unix timestamp of when token should expire.","format":"date-time"},"access":{"type":"string","description":"Token's capabilities.","default":"read","enum":["read","read/write"]}}}}}},"responses":{"200":{"description":"200","content":{"application/json":{"examples":{"Result":{"value":"{\n  \"token\": {\n    \"name\": \"AWS Lambda\",\n    \"slug\": \"56c69f96-3045-11ea-978f-2e728ce88125\",\n    \"created_at\": \"2019-11-19T07:19:01.073Z\",\n    \"key\": \"dp.st.gJ23agW5s09x4TKLMJMc4OPIr9fCm3bIs0QAC2L5\",\n    \"config\": \"dev\",\n    \"environment\": \"dev\",\n    \"project\": \"ed0c2a68b6t\",\n    \"expires_at\": null,\n    \"access\": \"read\"\n  }\n}"}},"schema":{"type":"object","properties":{"token":{"type":"object","properties":{"name":{"type":"string","example":"AWS Lambda"},"slug":{"type":"string","example":"56c69f96-3045-11ea-978f-2e728ce88125"},"created_at":{"type":"string","example":"2019-11-19T07:19:01.073Z"},"key":{"type":"string","example":"dp.st.gJ23agW5s09x4TKLMJMc4OPIr9fCm3bIs0QAC2L5"},"config":{"type":"string","example":"dev"},"environment":{"type":"string","example":"dev"},"project":{"type":"string","example":"ed0c2a68b6t"},"expires_at":{},"access":{"type":"string","example":"read"}}}}}}}}},"deprecated":false}},"/v3/configs/config/tokens/token":{"delete":{"summary":"Delete","description":"Service Token","operationId":"service_tokens-delete","requestBody":{"content":{"application/json":{"schema":{"type":"object","required":["project","config"],"properties":{"project":{"type":"string","description":"Unique identifier for the project object.","default":"PROJECT_NAME"},"config":{"type":"string","description":"Name of the config object.","default":"CONFIG_NAME"},"slug":{"type":"string","description":"The slug of the service token.","default":"TOKEN_SLUG"},"token":{"type":"string","description":"The token value.","default":"TOKEN_VALUE"}}}}}},"responses":{"200":{"description":"200","content":{"application/json":{"examples":{"Result":{"value":"{\n  \"success\": true\n}"}},"schema":{"type":"object","properties":{"success":{"type":"boolean","example":true,"default":true}}}}}}},"deprecated":false}},"/v3/workplace/invites":{"get":{"summary":"List","description":"","operationId":"invites-list","parameters":[{"name":"page","in":"query","schema":{"type":"integer","format":"int32","default":1}},{"name":"per_page","in":"query","schema":{"type":"integer","format":"int32","default":20}}],"responses":{"200":{"description":"200","content":{"application/json":{"examples":{"Result":{"value":"{\n  \"invites\": [{\n    \"slug\": \"00000000-0000-0000-0000-000000000000\",\n    \"email\": \"doppler@example.com\",\n    \"created_at\": \"2023-08-01T00:00:00.000Z\",\n    \"workplace_role\": {\n      \"name\": \"Custom\",\n      \"permissions\": [\"team\"],\n      \"identifier\": \"custom\",\n      \"created_at\": \"2023-08-01T00:00:00.000Z\",\n      \"is_custom_role\": false,\n      \"is_inline_role\": false\n    }\n  }]\n}"}},"schema":{"type":"object","properties":{"invites":{"type":"array","items":{"type":"object","properties":{"slug":{"type":"string","example":"00000000-0000-0000-0000-000000000000"},"email":{"type":"string","example":"doppler@example.com"},"created_at":{"type":"string","example":"2023-08-01T00:00:00.000Z"},"workplace_role":{"type":"object","properties":{"name":{"type":"string","example":"Custom"},"permissions":{"type":"array","items":{"type":"string","example":"team"}},"identifier":{"type":"string","example":"custom"},"created_at":{"type":"string","example":"2023-08-01T00:00:00.000Z"},"is_custom_role":{"type":"boolean","example":false,"default":true},"is_inline_role":{"type":"boolean","example":false,"default":true}}}}}}}}}}}},"deprecated":false}},"/v3/workplace/groups":{"get":{"summary":"List","description":"","operationId":"groups-list","parameters":[{"name":"page","in":"query","schema":{"type":"integer","format":"int32","default":1}},{"name":"per_page","in":"query","schema":{"type":"integer","format":"int32","default":20}}],"responses":{"200":{"description":"200","content":{"application/json":{"examples":{"Result":{"value":"{\n  \"groups\": [{\n    \"name\": \"group\",\n    \"slug\": \"00000000-0000-0000-0000-000000000000\",\n    \"created_at\": \"2023-08-01T00:00:00.000Z\",\n    \"default_project_role\": {\n      \"identifier\": \"no_access\"\n    }\n  }]\n}"}},"schema":{"type":"object","properties":{"groups":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","example":"group"},"slug":{"type":"string","example":"00000000-0000-0000-0000-000000000000"},"created_at":{"type":"string","example":"2023-08-01T00:00:00.000Z"},"default_project_role":{"type":"object","properties":{"identifier":{"type":"string","example":"no_access"}}}}}}}}}}}},"deprecated":false},"post":{"summary":"Create","description":"","operationId":"groups-create","requestBody":{"content":{"application/json":{"schema":{"type":"object","required":["name"],"properties":{"name":{"type":"string"},"default_project_role":{"type":"string","description":"Identifier of the project role"}}}}}},"responses":{"200":{"description":"200","content":{"application/json":{"examples":{"Result":{"value":"{\n  \"group\": {\n    \"name\": \"group\",\n    \"slug\": \"00000000-0000-0000-0000-000000000000\",\n    \"created_at\": \"2023-08-01T00:00:00.000Z\",\n    \"default_project_role\": {\n      \"identifier\": \"no_access\"\n    },\n    \"projects\": [{\n    \t\"name\": \"Project\",\n      \"slug\": \"project\",\n      \"role\": {\n        \"identifier\": \"viewer\"\n      }\n    }],\n    \"members\": [{\n      \"type\": \"workplace_user\",\n      \"slug\": \"00000000-0000-0000-0000-000000000000\"\n    }]\n  }\n}"}},"schema":{"type":"object","properties":{"group":{"type":"object","properties":{"name":{"type":"string","example":"group"},"slug":{"type":"string","example":"00000000-0000-0000-0000-000000000000"},"created_at":{"type":"string","example":"2023-08-01T00:00:00.000Z"},"default_project_role":{"type":"object","properties":{"identifier":{"type":"string","example":"no_access"}}},"projects":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","example":"Project"},"slug":{"type":"string","example":"project"},"role":{"type":"object","properties":{"identifier":{"type":"string","example":"viewer"}}}}}},"members":{"type":"array","items":{"type":"object","properties":{"type":{"type":"string","example":"workplace_user"},"slug":{"type":"string","example":"00000000-0000-0000-0000-000000000000"}}}}}}}}}}},"404":{"description":"404","content":{"text/plain":{"examples":{"Result":{"value":""}}}}}},"deprecated":false}},"/v3/workplace/groups/group/{slug}":{"get":{"summary":"Retrieve","description":"","operationId":"groups-get","parameters":[{"name":"slug","in":"path","description":"The group's slug","schema":{"type":"string"},"required":true}],"responses":{"200":{"description":"200","content":{"application/json":{"examples":{"Result":{"value":"{\n  \"group\": {\n    \"name\": \"group\",\n    \"slug\": \"00000000-0000-0000-0000-000000000000\",\n    \"created_at\": \"2023-08-01T00:00:00.000Z\",\n    \"default_project_role\": {\n      \"identifier\": \"no_access\"\n    },\n    \"projects\": [{\n    \t\"name\": \"Project\",\n      \"slug\": \"project\",\n      \"role\": {\n        \"identifier\": \"viewer\"\n      }\n    }],\n    \"members\": [{\n      \"type\": \"workplace_user\",\n      \"slug\": \"00000000-0000-0000-0000-000000000000\"\n    }]\n  }\n}"}},"schema":{"type":"object","properties":{"group":{"type":"object","properties":{"name":{"type":"string","example":"group"},"slug":{"type":"string","example":"00000000-0000-0000-0000-000000000000"},"created_at":{"type":"string","example":"2023-08-01T00:00:00.000Z"},"default_project_role":{"type":"object","properties":{"identifier":{"type":"string","example":"no_access"}}},"projects":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","example":"Project"},"slug":{"type":"string","example":"project"},"role":{"type":"object","properties":{"identifier":{"type":"string","example":"viewer"}}}}}},"members":{"type":"array","items":{"type":"object","properties":{"type":{"type":"string","example":"workplace_user"},"slug":{"type":"string","example":"00000000-0000-0000-0000-000000000000"}}}}}}}}}}},"404":{"description":"404","content":{"text/plain":{"examples":{"Result":{"value":""}}}}}},"deprecated":false},"patch":{"summary":"Update","description":"","operationId":"groups-update","parameters":[{"name":"slug","in":"path","description":"The group's slug","schema":{"type":"string"},"required":true}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string"},"default_project_role":{"type":"string","description":"Identifier of the project role"}}}}}},"responses":{"200":{"description":"200","content":{"application/json":{"examples":{"Result":{"value":"{\n  \"group\": {\n    \"name\": \"group\",\n    \"slug\": \"00000000-0000-0000-0000-000000000000\",\n    \"created_at\": \"2023-08-01T00:00:00.000Z\",\n    \"default_project_role\": {\n      \"identifier\": \"no_access\"\n    },\n    \"projects\": [{\n    \t\"name\": \"Project\",\n      \"slug\": \"project\",\n      \"role\": {\n        \"identifier\": \"viewer\"\n      }\n    }],\n    \"members\": [{\n      \"type\": \"workplace_user\",\n      \"slug\": \"00000000-0000-0000-0000-000000000000\"\n    }]\n  }\n}"}},"schema":{"type":"object","properties":{"group":{"type":"object","properties":{"name":{"type":"string","example":"group"},"slug":{"type":"string","example":"00000000-0000-0000-0000-000000000000"},"created_at":{"type":"string","example":"2023-08-01T00:00:00.000Z"},"default_project_role":{"type":"object","properties":{"identifier":{"type":"string","example":"no_access"}}},"projects":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","example":"Project"},"slug":{"type":"string","example":"project"},"role":{"type":"object","properties":{"identifier":{"type":"string","example":"viewer"}}}}}},"members":{"type":"array","items":{"type":"object","properties":{"type":{"type":"string","example":"workplace_user"},"slug":{"type":"string","example":"00000000-0000-0000-0000-000000000000"}}}}}}}}}}},"404":{"description":"404","content":{"text/plain":{"examples":{"Result":{"value":""}}}}}},"deprecated":false},"delete":{"summary":"Delete","description":"","operationId":"groups-delete","parameters":[{"name":"slug","in":"path","description":"The group's slug","schema":{"type":"string"},"required":true}],"responses":{"204":{"description":"204","content":{"application/json":{"examples":{"Result":{"value":""}}}}}},"deprecated":false}},"/v3/workplace/groups/group/{slug}/members":{"post":{"summary":"Add Member","description":"","operationId":"groups-add_member","parameters":[{"name":"slug","in":"path","description":"The group's slug","schema":{"type":"string"},"required":true}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","required":["type","slug"],"properties":{"type":{"type":"string","enum":["workplace_user"]},"slug":{"type":"string","description":"The member's slug"}}}}}},"responses":{"204":{"description":"204","content":{"application/json":{"examples":{"Result":{"value":""}}}}},"409":{"description":"409","content":{"text/plain":{"examples":{"Result":{"value":""}}}}}},"deprecated":false}},"/v3/workplace/groups/group/{slug}/members/{type}/{member_slug}":{"delete":{"summary":"Delete Member","description":"","operationId":"groups-delete_member","parameters":[{"name":"slug","in":"path","description":"The group's slug","schema":{"type":"string"},"required":true},{"name":"type","in":"path","required":true,"schema":{"type":"string","enum":["workplace_user"]}},{"name":"member_slug","in":"path","description":"The member's slug","required":true,"schema":{"type":"string"}}],"responses":{"204":{"description":"204","content":{"application/json":{"examples":{"Result":{"value":""}}}}}},"deprecated":false}},"/v3/workplace/groups/group/{group_slug}/members/{member_type}/{member_slug}":{"get":{"summary":"Retrieve Member","description":"","operationId":"retrieve-member","parameters":[{"name":"group_slug","in":"path","description":"The group's slug","schema":{"type":"string"},"required":true},{"name":"member_type","in":"path","schema":{"type":"string","enum":["workplace_user"]},"required":true},{"name":"member_slug","in":"path","description":"The member's slug","schema":{"type":"string"},"required":true}],"responses":{"204":{"description":"204","content":{"application/json":{"examples":{"Result":{"value":"{\n  \"group\": {\n    \"name\": \"group\",\n    \"slug\": \"00000000-0000-0000-0000-000000000000\",\n    \"created_at\": \"2023-08-01T00:00:00.000Z\",\n    \"default_project_role\": {\n      \"identifier\": \"no_access\"\n    },\n    \"projects\": [{\n    \t\"name\": \"Project\",\n      \"slug\": \"project\",\n      \"role\": {\n        \"identifier\": \"viewer\"\n      }\n    }],\n    \"members\": [{\n      \"type\": \"workplace_user\",\n      \"slug\": \"00000000-0000-0000-0000-000000000000\"\n    }]\n  }\n}"}},"schema":{"type":"object","properties":{"group":{"type":"object","properties":{"name":{"type":"string","example":"group"},"slug":{"type":"string","example":"00000000-0000-0000-0000-000000000000"},"created_at":{"type":"string","example":"2023-08-01T00:00:00.000Z"},"default_project_role":{"type":"object","properties":{"identifier":{"type":"string","example":"no_access"}}},"projects":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","example":"Project"},"slug":{"type":"string","example":"project"},"role":{"type":"object","properties":{"identifier":{"type":"string","example":"viewer"}}}}}},"members":{"type":"array","items":{"type":"object","properties":{"type":{"type":"string","example":"workplace_user"},"slug":{"type":"string","example":"00000000-0000-0000-0000-000000000000"}}}}}}}}}}},"404":{"description":"404","content":{"text/plain":{"examples":{"Result":{"value":""}}}}}},"deprecated":false}},"/v3/workplace/service_accounts":{"get":{"summary":"List","description":"","operationId":"service_accounts-list","parameters":[{"name":"page","in":"query","schema":{"type":"integer","format":"int32","default":1}},{"name":"per_page","in":"query","schema":{"type":"integer","format":"int32","default":20}}],"responses":{"200":{"description":"200","content":{"application/json":{"examples":{"Result":{"value":"{\n  \"service_accounts\": [{\n    \"name\": \"sa\",\n    \"slug\": \"00000000-0000-0000-0000-000000000000\",\n    \"created_at\": \"2023-08-01T00:00:00.000Z\",\n    \"workplace_role\": {\n      \"name\": \"Custom\",\n      \"permissions\": [\"team\"],\n      \"identifier\": \"custom\",\n      \"created_at\": \"2023-08-01T00:00:00.000Z\",\n      \"is_custom_role\": false,\n      \"is_inline_role\": false\n    }\n  }]\n}"}},"schema":{"type":"object","properties":{"service_accounts":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","example":"sa"},"slug":{"type":"string","example":"00000000-0000-0000-0000-000000000000"},"created_at":{"type":"string","example":"2023-08-01T00:00:00.000Z"},"workplace_role":{"type":"object","properties":{"name":{"type":"string","example":"Custom"},"permissions":{"type":"array","items":{"type":"string","example":"team"}},"identifier":{"type":"string","example":"custom"},"created_at":{"type":"string","example":"2023-08-01T00:00:00.000Z"},"is_custom_role":{"type":"boolean","example":false,"default":true},"is_inline_role":{"type":"boolean","example":false,"default":true}}}}}}}}}}}},"deprecated":false},"post":{"summary":"Create","description":"","operationId":"service_accounts-create","requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string"},"workplace_role":{"type":"object","description":"You may provide an identifier OR permissions, but not both","properties":{"identifier":{"type":"string","description":"Identifier of an existing workplace role"},"permissions":{"type":"array","description":"Workplace permissions to grant","items":{"type":"string"}}}}}}}}},"responses":{"200":{"description":"200","content":{"application/json":{"examples":{"Result":{"value":"{\n  \"service_account\": {\n    \"name\": \"sa\",\n    \"slug\": \"00000000-0000-0000-0000-000000000000\",\n    \"created_at\": \"2023-08-01T00:00:00.000Z\",\n    \"workplace_role\": {\n      \"name\": \"Custom\",\n      \"permissions\": [\"team\"],\n      \"identifier\": \"custom\",\n      \"created_at\": \"2023-08-01T00:00:00.000Z\",\n      \"is_custom_role\": false,\n      \"is_inline_role\": false\n    }\n  }\n}"}},"schema":{"type":"object","properties":{"service_account":{"type":"object","properties":{"name":{"type":"string","example":"sa"},"slug":{"type":"string","example":"00000000-0000-0000-0000-000000000000"},"created_at":{"type":"string","example":"2023-08-01T00:00:00.000Z"},"workplace_role":{"type":"object","properties":{"name":{"type":"string","example":"Custom"},"permissions":{"type":"array","items":{"type":"string","example":"team"}},"identifier":{"type":"string","example":"custom"},"created_at":{"type":"string","example":"2023-08-01T00:00:00.000Z"},"is_custom_role":{"type":"boolean","example":false,"default":true},"is_inline_role":{"type":"boolean","example":false,"default":true}}}}}}}}}}},"deprecated":false}},"/v3/workplace/service_accounts/service_account/{slug}":{"get":{"summary":"Retrieve","description":"","operationId":"service_accounts-get","parameters":[{"name":"slug","in":"path","description":"Slug of the service account","schema":{"type":"string"},"required":true}],"responses":{"200":{"description":"200","content":{"application/json":{"examples":{"Result":{"value":"{\n  \"service_account\": {\n    \"name\": \"sa\",\n    \"slug\": \"00000000-0000-0000-0000-000000000000\",\n    \"created_at\": \"2023-08-01T00:00:00.000Z\",\n    \"workplace_role\": {\n      \"name\": \"Custom\",\n      \"permissions\": [\"team\"],\n      \"identifier\": \"custom\",\n      \"created_at\": \"2023-08-01T00:00:00.000Z\",\n      \"is_custom_role\": false,\n      \"is_inline_role\": false\n    }\n  }\n}"}},"schema":{"type":"object","properties":{"service_account":{"type":"object","properties":{"name":{"type":"string","example":"sa"},"slug":{"type":"string","example":"00000000-0000-0000-0000-000000000000"},"created_at":{"type":"string","example":"2023-08-01T00:00:00.000Z"},"workplace_role":{"type":"object","properties":{"name":{"type":"string","example":"Custom"},"permissions":{"type":"array","items":{"type":"string","example":"team"}},"identifier":{"type":"string","example":"custom"},"created_at":{"type":"string","example":"2023-08-01T00:00:00.000Z"},"is_custom_role":{"type":"boolean","example":false,"default":true},"is_inline_role":{"type":"boolean","example":false,"default":true}}}}}}}}}},"404":{"description":"404","content":{"text/plain":{"examples":{"Result":{"value":""}}}}}},"deprecated":false},"patch":{"summary":"Update","description":"","operationId":"service_accounts-update","parameters":[{"name":"slug","in":"path","description":"Slug of the service account","schema":{"type":"string"},"required":true}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string"},"workplace_role":{"type":"object","description":"You may provide an identifier OR permissions, but not both","properties":{"identifier":{"type":"string","description":"Identifier of an existing workplace role"},"permissions":{"type":"array","description":"Workplace permissions to grant","items":{"type":"string"}}}}}}}}},"responses":{"200":{"description":"200","content":{"application/json":{"examples":{"Result":{"value":"{\n  \"service_account\": {\n    \"name\": \"sa\",\n    \"slug\": \"00000000-0000-0000-0000-000000000000\",\n    \"created_at\": \"2023-08-01T00:00:00.000Z\",\n    \"workplace_role\": {\n      \"name\": \"None\",\n      \"permissions\": [],\n      \"identifier\": \"no_access\",\n      \"created_at\": \"2023-08-01T00:00:00.000Z\",\n      \"is_custom_role\": false,\n      \"is_inline_role\": false\n    }\n  }\n}"}},"schema":{"type":"object","properties":{"service_account":{"type":"object","properties":{"name":{"type":"string","example":"sa"},"slug":{"type":"string","example":"00000000-0000-0000-0000-000000000000"},"created_at":{"type":"string","example":"2023-08-01T00:00:00.000Z"},"workplace_role":{"type":"object","properties":{"name":{"type":"string","example":"None"},"permissions":{"type":"array"},"identifier":{"type":"string","example":"no_access"},"created_at":{"type":"string","example":"2023-08-01T00:00:00.000Z"},"is_custom_role":{"type":"boolean","example":false,"default":true},"is_inline_role":{"type":"boolean","example":false,"default":true}}}}}}}}}},"404":{"description":"404","content":{"text/plain":{"examples":{"Result":{"value":""}}}}}},"deprecated":false},"delete":{"summary":"Delete","description":"","operationId":"service_accounts-delete","parameters":[{"name":"slug","in":"path","description":"Slug of the service account","schema":{"type":"string"},"required":true}],"responses":{"204":{"description":"204","content":{"application/json":{"examples":{"Result":{"value":""}}}}},"404":{"description":"404","content":{"text/plain":{"examples":{"Result":{"value":""}}}}}},"deprecated":false}},"/v3/workplace/service_accounts/service_account/{service_account}/tokens":{"get":{"summary":"List","description":"List information about existing service account API tokens.","operationId":"service_account_tokens-list","parameters":[{"name":"page","in":"query","schema":{"type":"integer","format":"int32","default":1}},{"name":"per_page","in":"query","schema":{"type":"integer","format":"int32","default":20}},{"name":"service_account","in":"path","description":"Slug of the service account","schema":{"type":"string"},"required":true}],"responses":{"200":{"description":"200","content":{"application/json":{"examples":{"Result":{"value":"{\n  \"api_tokens\": [{\n    \"name\": \"token\",\n    \"slug\": \"00000000-0000-0000-0000-000000000000\",\n    \"created_at\": \"2023-08-01T00:00:00.000Z\",\n    \"last_seen_at\": \"2024-01-05T00:00:00.000Z\",\n    \"expires_at\": \"2024-02-01T00:00:00.000Z\"\n  }],\n  \"success\": true\n}"}},"schema":{"type":"object","properties":{"api_tokens":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","example":"token"},"slug":{"type":"string","example":"00000000-0000-0000-0000-000000000000"},"created_at":{"type":"string","example":"2023-08-01T00:00:00.000Z"},"last_seen_at":{"type":"string","example":"2024-01-05T00:00:00.000Z"},"expires_at":{"type":"string","example":"2024-02-01T00:00:00.000Z"}}}},"success":{"type":"boolean","example":true,"default":true}}}}}}},"deprecated":false},"post":{"summary":"Create","description":"Generate a new service account API token.","operationId":"service_account_tokens-create","parameters":[{"name":"service_account","in":"path","description":"Slug of the service account","schema":{"type":"string"},"required":true}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","description":"The display name of the API token"},"expires_at":{"type":"string","description":"The datetime at which the API token should expire. If not provided, the API token will remain vaild indefinitely unless manually revoked","format":"date-time"}}}}}},"responses":{"200":{"description":"200","content":{"application/json":{"examples":{"Result":{"value":"{\n  \"api_token\": {\n    \"name\": \"token\",\n    \"slug\": \"00000000-0000-0000-0000-000000000000\",\n    \"created_at\": \"2023-03-14T00:00:00.000Z\",\n    \"last_seen_at\": null,\n    \"expires_at\": \"2023-08-01T00:00:00.000Z\"\n  },\n  \"api_key\": \"dp.sa.0000000000000000000000000000\",\n  \"success\": true\n}"}},"schema":{"type":"object","properties":{"api_token":{"type":"object","properties":{"name":{"type":"string","example":"token"},"slug":{"type":"string","example":"00000000-0000-0000-0000-000000000000"},"created_at":{"type":"string","example":"2023-03-14T00:00:00.000Z"},"last_seen_at":{},"expires_at":{"type":"string","example":"2023-08-01T00:00:00.000Z"}}},"api_key":{"type":"string","example":"dp.sa.0000000000000000000000000000"},"success":{"type":"boolean","example":true,"default":true}}}}}}},"deprecated":false}},"/v3/workplace/service_accounts/service_account/{service_account}/tokens/token/{api_token}":{"get":{"summary":"Retrieve","description":"Retrieve information about a single service account API token.","operationId":"service_account_tokens-get","parameters":[{"name":"service_account","in":"path","description":"Slug of the service account","schema":{"type":"string"},"required":true},{"name":"api_token","in":"path","description":"Slug of the API token","schema":{"type":"string"},"required":true}],"responses":{"200":{"description":"200","content":{"application/json":{"examples":{"Result":{"value":"{\n  \"api_token\": {\n    \"name\": \"token\",\n    \"slug\": \"00000000-0000-0000-0000-000000000000\",\n    \"created_at\": \"2023-03-14T00:00:00.000Z\",\n    \"last_seen_at\": \"2023-06-22T00:00:00.000Z\",\n    \"expires_at\": \"2023-08-01T00:00:00.000Z\"\n  },\n  \"success\": true\n}"}},"schema":{"type":"object","properties":{"api_token":{"type":"object","properties":{"name":{"type":"string","example":"token"},"slug":{"type":"string","example":"00000000-0000-0000-0000-000000000000"},"created_at":{"type":"string","example":"2023-03-14T00:00:00.000Z"},"last_seen_at":{"type":"string","example":"2023-06-22T00:00:00.000Z"},"expires_at":{"type":"string","example":"2023-08-01T00:00:00.000Z"}}},"success":{"type":"boolean","example":true,"default":true}}}}}},"404":{"description":"404","content":{"application/json":{"examples":{"Result":{"value":"{ \n  \"messages\": [\"Service account API token does not exist\"], \n  \"success\": false \n}"}},"schema":{"type":"object","properties":{"messages":{"type":"array","items":{"type":"string","example":"Service account API token does not exist"}},"success":{"type":"boolean","example":false,"default":true}}}}}}},"deprecated":false},"delete":{"summary":"Delete","description":"Revoke an existing service account API token.","operationId":"service_account_tokens-delete","parameters":[{"name":"service_account","in":"path","description":"Slug of the service account","schema":{"type":"string"},"required":true},{"name":"api_token","in":"path","description":"Slug of the API token","schema":{"type":"string"},"required":true}],"responses":{"204":{"description":"204","content":{"application/json":{"examples":{"Result":{"value":""}}}}},"404":{"description":"404","content":{"application/json":{"examples":{"Result":{"value":"{ \n  \"messages\": [\"Service account API token does not exist\"], \n  \"success\": false \n}"}},"schema":{"type":"object","properties":{"messages":{"type":"array","items":{"type":"string","example":"Service account API token does not exist"}},"success":{"type":"boolean","example":false,"default":true}}}}}}},"deprecated":false}},"/v3/webhooks":{"get":{"summary":"List","description":"Webhooks","operationId":"webhooks-list","parameters":[{"name":"project","in":"query","description":"The project's name","schema":{"type":"string"}}],"responses":{"200":{"description":"200","content":{"application/json":{"examples":{"Result":{"value":"{}"}},"schema":{"type":"object","properties":{"webhooks":{"type":"array","items":{"properties":{"id":{"type":"string","description":"Webhook's slug"},"name":{"type":"string","description":"Webhook's name"},"url":{"type":"string","description":"Webhook's URL"},"enabled":{"type":"boolean","description":"Whether the webhook is enabled or disabled"},"hasSecret":{"type":"boolean","description":"Whether the webhook has a secret set. See: https://docs.doppler.com/docs/webhooks#verify-webhook-with-request-signing"},"authentication":{"type":"object","description":"Webhook's authentication type","properties":{"type":{"type":"string","enum":["None","Basic","Bearer"]}}},"enabledConfigs":{"type":"array","description":"The configs the webhook will trigger for","items":{"type":"string"}},"canManage":{"type":"boolean","description":"Whether the requestor has permission to modify the webhook"}},"type":"object"}}},"required":["webhooks"]}}}},"400":{"description":"400","content":{"application/json":{"examples":{"Result":{"value":"{}"}},"schema":{"type":"object","properties":{}}}}}},"deprecated":false},"post":{"summary":"Add","description":"Webhook","operationId":"webhooks-add","parameters":[{"name":"project","in":"query","description":"The project's name","schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","required":["url"],"properties":{"url":{"type":"string","description":"The webhook URL. Must be https"},"secret":{"type":"string","description":"See: https://docs.doppler.com/docs/webhooks#verify-webhook-with-request-signing"},"authentication":{"type":"object","properties":{"type":{"type":"string","enum":["None","Bearer","Basic"]},"token":{"type":"string","description":"Used when type = Bearer"},"username":{"type":"string","description":"Used when type = Basic"},"password":{"type":"string","description":"Used when type = Basic"}}},"payload":{"type":"string","description":"See: https://docs.doppler.com/docs/webhooks#default-payload","format":"json"},"enableConfigs":{"type":"array","description":"Config slugs that the webhook should be enabled for","items":{"type":"string"}},"name":{"type":"string","description":"The name of the webhook."}}}}}},"responses":{"200":{"description":"200","content":{"application/json":{"examples":{"Result":{"value":"{}"}},"schema":{"type":"object","properties":{}}}}},"400":{"description":"400","content":{"application/json":{"examples":{"Result":{"value":"{}"}},"schema":{"type":"object","properties":{}}}}}},"deprecated":false}},"/v3/webhooks/webhook/{slug}":{"get":{"summary":"Retrieve","description":"Webhook","operationId":"webhooks-get","parameters":[{"name":"slug","in":"path","description":"Webhook's slug","schema":{"type":"string"},"required":true},{"name":"project","in":"query","description":"The project's name","schema":{"type":"string"}}],"responses":{"200":{"description":"200","content":{"application/json":{"examples":{"Result":{"value":"{}"}},"schema":{"type":"object","properties":{"webhook":{"type":"object","properties":{"id":{"type":"string","description":"Webhook's slug"},"name":{"type":"string","description":"Webhook's name"},"url":{"type":"string","description":"Webhook's URL"},"enabled":{"type":"boolean","description":"Whether the webhook is enabled or disabled"},"hasSecret":{"type":"boolean","description":"Whether the webhook has a secret set. See: https://docs.doppler.com/docs/webhooks#verify-webhook-with-request-signing"},"authentication":{"type":"object","properties":{"type":{"type":"string","enum":["None","Basic","Bearer"]}},"description":"Webhook's authentication type"},"enabledConfigs":{"type":"array","items":{"type":"string"},"description":"The configs the webhook will trigger for"},"canManage":{"type":"boolean","description":"Whether the requestor has permission to modify the webhook"}}}},"required":["webhook"]}}}},"400":{"description":"400","content":{"application/json":{"examples":{"Result":{"value":"{}"}},"schema":{"type":"object","properties":{}}}}}}},"patch":{"summary":"Update","description":"Webhook","operationId":"webhooks-update","parameters":[{"name":"project","in":"query","description":"The project's name","schema":{"type":"string"}},{"name":"slug","in":"path","description":"Webhook's slug","schema":{"type":"string"},"required":true}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"url":{"type":"string","description":"The webhook URL. Must be https"},"secret":{"type":"string","description":"See: https://docs.doppler.com/docs/webhooks#verify-webhook-with-request-signing"},"authentication":{"type":"object","properties":{"type":{"type":"string","enum":["None","Bearer","Basic"]},"token":{"type":"string","description":"Used when type = Bearer"},"username":{"type":"string","description":"Used when type = Basic"},"password":{"type":"string","description":"Used when type = Basic"}}},"payload":{"type":"string","description":"See: https://docs.doppler.com/docs/webhooks#default-payload","format":"json"},"name":{"type":"string","description":"Name of the webhook."},"enableConfigs":{"type":"array","description":"Config slugs that the webhook should be enabled for","items":{"type":"string"}},"disableConfigs":{"type":"array","description":"Config slugs that the webhook should be disabled for","items":{"type":"string"}}}}}}},"responses":{"200":{"description":"200","content":{"application/json":{"examples":{"Result":{"value":"{}"}},"schema":{"type":"object","properties":{}}}}},"400":{"description":"400","content":{"application/json":{"examples":{"Result":{"value":"{}"}},"schema":{"type":"object","properties":{}}}}}},"deprecated":false},"delete":{"summary":"Delete","description":"Webhook","operationId":"webhooks-delete","parameters":[{"name":"project","in":"query","description":"The project's name","schema":{"type":"string"}},{"name":"slug","in":"path","description":"Webhook's slug","schema":{"type":"string"},"required":true}],"responses":{"200":{"description":"200","content":{"application/json":{"examples":{"Result":{"value":"{}"}},"schema":{"type":"object","properties":{}}}}},"400":{"description":"400","content":{"application/json":{"examples":{"Result":{"value":"{}"}},"schema":{"type":"object","properties":{}}}}}},"deprecated":false}},"/v3/webhooks/webhook/{slug}/enable":{"post":{"summary":"Enable","description":"Webhook","operationId":"webhooks-enable","parameters":[{"name":"project","in":"query","description":"The project's name","schema":{"type":"string"}},{"name":"slug","in":"path","description":"Webhook's slug","schema":{"type":"string"},"required":true}],"responses":{"200":{"description":"200","content":{"application/json":{"examples":{"Result":{"value":"{}"}},"schema":{"type":"object","properties":{}}}}},"400":{"description":"400","content":{"application/json":{"examples":{"Result":{"value":"{}"}},"schema":{"type":"object","properties":{}}}}}},"deprecated":false}},"/v3/webhooks/webhook/{slug}/disable":{"post":{"summary":"Disable","description":"Webhook","operationId":"webhooks-disable","parameters":[{"name":"project","in":"query","description":"The project's name","schema":{"type":"string"}},{"name":"slug","in":"path","description":"Webhook's slug","schema":{"type":"string"},"required":true}],"responses":{"200":{"description":"200","content":{"application/json":{"examples":{"Result":{"value":"{}"}},"schema":{"type":"object","properties":{}}}}},"400":{"description":"400","content":{"application/json":{"examples":{"Result":{"value":"{}"}},"schema":{"type":"object","properties":{}}}}}},"deprecated":false}},"/v3/workplace/change_request_policies":{"get":{"summary":"List","description":"List existing change request policies","operationId":"change-request-policies-list","responses":{"200":{"description":"200","content":{"application/json":{"examples":{"Result":{"value":"{\n    \"policies\": [\n        {\n            \"policy\": {\n                \"id\": \"00000000-0000-0000-0000-000000000000\",\n                \"name\": \"Reviewer Policy\",\n                \"description\": \"A description of the policy.\",\n                \"rules\": [\n//                 {\n//                     \"type\": \"RequiredReviewer\",\n//                     \"count\": 1,\n//                     \"subjects\": [\n//                         {\n//                             \"type\": \"WorkplaceUser\",\n//                             \"slug\": \"00000000-0000-0000-0000-000000000000\",\n//                             \"name\": \"John Developer\",\n//                             \"description\": \"john.dev@doppler.com\",\n//                             \"isActive\": true,\n//                             \"image\": \"https://www.gravatar.com/avatar/0000\"\n//                         }\n//                     ]\n//                 }\n                ],\n                \"targets\": {\n                    \"allProjects\": false,\n                    \"projects\": {\n//                      \"example-project-a\": {\n//                          \"all\": true\n//                      },\n//                      \"example-project-b\": {\n//                          \"all\": false,\n//                          \"envSlugs\": [\"dev\"],\n//                          \"configNames\": []\n//                      },\n//                      \"example-project-c\": {\n//                          \"all\": false,\n//                          \"envSlugs\": [],\n//                         \"configNames\": [\"prd_infra\"]\n//                      }\n                    }\n                }\n            }\n        }\n    ],\n    \"success\": true\n}"}},"schema":{"type":"object","properties":{"policies":{"type":"array","items":{"type":"object","properties":{"policy":{"type":"object","properties":{"id":{"type":"string","example":"00000000-0000-0000-0000-000000000000"},"name":{"type":"string","example":"Reviewer Policy"},"description":{"type":"string","example":"A description of the policy."},"rules":{"type":"array"},"targets":{"type":"object","properties":{"allProjects":{"type":"boolean","example":false,"default":true},"projects":{"type":"object","properties":{}}}}}}}}},"success":{"type":"boolean","example":true,"default":true}}}}}},"400":{"description":"400","content":{"application/json":{"examples":{"Result":{"value":"{}"}},"schema":{"type":"object","properties":{}}}}}},"deprecated":false},"post":{"summary":"Create","description":"Create a new change request policy","operationId":"change-request-policies-create","requestBody":{"content":{"application/json":{"schema":{"type":"object","required":["name","rules","targets"],"properties":{"name":{"type":"string","description":"The name of the policy."},"description":{"type":"string","description":"An optional description of the policy."},"rules":{"type":"array","description":"A list of rules the policy enforces.","items":{"properties":{"type":{"type":"string","enum":["\"RequiredReviewer\"","\"DisallowSelfReview\""]},"count":{"type":"integer","description":"The number of required reviewers. Only applies to \"RequiredReviewer\" rules.","default":1,"format":"int32"},"subjects":{"type":"array","description":"A list of required reviewers. If specified, only reviews from reviewers in this list will satisfy the policy. Only applies to \"RequiredReviewer\" rules.","items":{"properties":{"type":{"type":"string","description":"The type of the subject.","enum":["\"WorkplaceUser\"","\"Group\""]},"slug":{"type":"string","description":"The unique identifier of the subject."}},"required":["type","slug"],"type":"object"}}},"required":["type"],"type":"object"}},"targets":{"type":"object","description":"Describes the which projects, environments, and configs the policy applies to.","properties":{"allProjects":{"type":"boolean","description":"If true, the policy will apply to every config in the workplace."},"projects":{"type":"string","description":"A dictionary where the key is the project name, and the value contains information about what within the project the policy should apply to.","format":"json"}}}}}}}},"responses":{"200":{"description":"200","content":{"application/json":{"examples":{"Result":{"value":"{\n    \"policy\": {\n        \"id\": \"00000000-0000-0000-0000-000000000000\",\n        \"name\": \"New Policy\",\n        \"description\": \"This policy requires 2 reviewers and does not allow self-reviews.\",\n        \"rules\": [\n//          {\n//              \"type\": \"RequiredReviewer\",\n//              \"count\": 2,\n//              \"subjects\": null\n//          },\n//          {\n//              \"type\": \"RequiredReviewer\",\n//              \"count\": 1,\n//              \"subjects\": [\n//                  {\n//                      \"type\": \"WorkplaceUser\",\n//                      \"slug\": \"00000000-0000-0000-0000-000000000000\"\n//                  }\n//              ]\n//          },\n//          {\n//              \"type\": \"DisallowSelfReview\"\n//          }\n        ],\n        \"targets\": {\n            \"allProjects\": false,\n            \"projects\": {\n//              \"example-project-a\": {\n//                  \"all\": true\n//              },\n//              \"example-project-b\": {\n//                  \"all\": false,\n//                  \"envSlugs\": [\"dev\"],\n//                  \"configNames\": []\n//              },\n//              \"example-project-c\": {\n//                  \"all\": false,\n//                  \"envSlugs\": [],\n//                 \"configNames\": [\"prd_infra\"]\n//              }\n            }\n        }\n    },\n    \"success\": true\n}"}},"schema":{"type":"object","properties":{"policy":{"type":"object","properties":{"id":{"type":"string","example":"00000000-0000-0000-0000-000000000000"},"name":{"type":"string","example":"New Policy"},"description":{"type":"string","example":"This policy requires 2 reviewers and does not allow self-reviews."},"rules":{"type":"array"},"targets":{"type":"object","properties":{"allProjects":{"type":"boolean","example":false,"default":true},"projects":{"type":"object","properties":{}}}}}},"success":{"type":"boolean","example":true,"default":true}}}}}}},"deprecated":false}},"/v3/workplace/change_request_policies/change_request_policy/{slug}":{"get":{"summary":"Retrieve","description":"Fetch an existing change request policy","operationId":"change-request-policies-get","parameters":[{"name":"slug","in":"path","description":"Unique id of the policy","schema":{"type":"string"},"required":true}],"responses":{"200":{"description":"200","content":{"application/json":{"examples":{"Result":{"value":"{\n    \"policy\": {\n        \"id\": \"00000000-0000-0000-0000-000000000000\",\n        \"name\": \"Reviewer Policy\",\n        \"description\": \"A description of the policy.\",\n        \"rules\": [\n //         {\n //             \"type\": \"RequiredReviewer\",\n //             \"count\": 1,\n //             \"subjects\": [\n //                 {\n //                     \"type\": \"WorkplaceUser\",\n //                     \"slug\": \"00000000-0000-0000-0000-000000000000\",\n //                     \"name\": \"John Developer\",\n //                     \"description\": \"john.dev@doppler.com\",\n //                     \"isActive\": true,\n //                     \"image\": \"https://www.gravatar.com/avatar/0000\"\n //                 }\n //             ]\n //         }\n        ],\n        \"targets\": {\n            \"allProjects\": false,\n            \"projects\": {\n//              \"example-project-a\": {\n//                  \"all\": true\n//              },\n//              \"example-project-b\": {\n//                  \"all\": false,\n//                  \"envSlugs\": [\"dev\"],\n//                  \"configNames\": []\n//              },\n//              \"example-project-c\": {\n//                  \"all\": false,\n//                  \"envSlugs\": [],\n//                 \"configNames\": [\"prd_infra\"]\n//              }\n            }\n        }\n    },\n    \"success\": true\n}"}},"schema":{"type":"object","properties":{"policy":{"type":"object","properties":{"id":{"type":"string","example":"00000000-0000-0000-0000-000000000000"},"name":{"type":"string","example":"Reviewer Policy"},"description":{"type":"string","example":"A description of the policy."},"rules":{"type":"array"},"targets":{"type":"object","properties":{"allProjects":{"type":"boolean","example":false,"default":true},"projects":{"type":"object","properties":{}}}}}},"success":{"type":"boolean","example":true,"default":true}}}}}}},"deprecated":false},"post":{"summary":"Update","description":"Update an existing change request policy","operationId":"change-request-policies-update","parameters":[{"name":"slug","in":"path","description":"The unique identifier of the policy.","schema":{"type":"string"},"required":true}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","required":["name","rules","targets"],"properties":{"name":{"type":"string","description":"The name of the policy."},"description":{"type":"string","description":"An optional description of the policy."},"rules":{"type":"array","description":"A list of rules the policy enforces.","items":{"properties":{"type":{"type":"string","enum":["\"RequiredReviewer\"","\"DisallowSelfReview\""]},"count":{"type":"integer","description":"The number of required reviewers. Only applies to \"RequiredReviewer\" rules.","default":1,"format":"int32"},"subjects":{"type":"array","description":"A list of required reviewers. If specified, only reviews from reviewers in this list will satisfy the policy. Only applies to \"RequiredReviewer\" rules.","items":{"properties":{"type":{"type":"string","description":"The type of the subject.","enum":["\"WorkplaceUser\"","\"Group\""]},"slug":{"type":"string","description":"The unique identifier of the subject."}},"required":["type","slug"],"type":"object"}}},"required":["type"],"type":"object"}},"targets":{"type":"object","description":"Describes the which projects, environments, and configs the policy applies to.","properties":{"allProjects":{"type":"boolean","description":"If true, the policy will apply to every config in the workplace."},"projects":{"type":"string","description":"A dictionary where the key is the project name, and the value contains information about what within the project the policy should apply to.","format":"json"}}}}}}}},"responses":{"200":{"description":"200","content":{"application/json":{"examples":{"Result":{"value":"{\n    \"policy\": {\n        \"id\": \"00000000-0000-0000-0000-000000000000\",\n        \"name\": \"New Policy\",\n        \"description\": \"This policy requires 2 reviewers and does not allow self-reviews.\",\n        \"rules\": [\n//          {\n//              \"type\": \"RequiredReviewer\",\n//              \"count\": 2,\n//              \"subjects\": null\n//          },\n//          {\n//              \"type\": \"RequiredReviewer\",\n//              \"count\": 1,\n//              \"subjects\": [\n//                  {\n//                      \"type\": \"WorkplaceUser\",\n//                      \"slug\": \"00000000-0000-0000-0000-000000000000\"\n//                  }\n//              ]\n//          },\n//          {\n//              \"type\": \"DisallowSelfReview\"\n//          }\n        ],\n        \"targets\": {\n            \"allProjects\": false,\n            \"projects\": {\n//              \"example-project-a\": {\n//                  \"all\": true\n//              },\n//              \"example-project-b\": {\n//                  \"all\": false,\n//                  \"envSlugs\": [\"dev\"],\n//                  \"configNames\": []\n//              },\n//              \"example-project-c\": {\n//                  \"all\": false,\n//                  \"envSlugs\": [],\n//                 \"configNames\": [\"prd_infra\"]\n//              }\n            }\n        }\n    },\n    \"success\": true\n}"}},"schema":{"type":"object","properties":{"policy":{"type":"object","properties":{"id":{"type":"string","example":"00000000-0000-0000-0000-000000000000"},"name":{"type":"string","example":"New Policy"},"description":{"type":"string","example":"This policy requires 2 reviewers and does not allow self-reviews."},"rules":{"type":"array"},"targets":{"type":"object","properties":{"allProjects":{"type":"boolean","example":false,"default":true},"projects":{"type":"object","properties":{}}}}}},"success":{"type":"boolean","example":true,"default":true}}}}}}},"deprecated":false},"delete":{"summary":"Delete","description":"Delete an existing change request policy","operationId":"change-request-policies-delete","parameters":[{"name":"slug","in":"path","description":"The unique identifier of the policy.","schema":{"type":"string"},"required":true}],"responses":{"200":{"description":"200","content":{"application/json":{"examples":{"Result":{"value":"{\n    \"success\": true\n}"}},"schema":{"type":"object","properties":{"success":{"type":"boolean","example":true,"default":true}}}}}}},"deprecated":false}},"/v3/auth/revoke":{"post":{"summary":"Revoke","description":"Revoke an auth token","operationId":"auth-revoke","requestBody":{"content":{"application/json":{"schema":{"type":"object","required":["token"],"properties":{"token":{"type":"string"}}}}}},"responses":{"200":{"description":"200","content":{"application/json":{"examples":{"Result":{"value":""}}}}}},"deprecated":false,"security":[]}},"/v3/auth/oidc":{"post":{"summary":"OIDC (Service Account Identity)","description":"Authenticate via a Service Account Identity with OIDC. Returns a short lived API token.","operationId":"auth-oidc","requestBody":{"content":{"application/json":{"schema":{"type":"object","required":["token","identity"],"properties":{"token":{"type":"string","description":"the OIDC token string from your OIDC provider (likely CI)"},"identity":{"type":"string","description":"Identity ID from the Doppler Dashboard"}}}}}},"responses":{"200":{"description":"200","content":{"application/json":{"examples":{"Result":{"value":"{\n  \"token\": \"dp.said.bAqhcVzrhy5cRHkOlNTc0Ve6w5NUDCpcutm8vGE9myi\",\n  \"expires_at\": \"2025-01-17T16:46:46.171Z\"\n}"}},"schema":{"type":"object","properties":{"token":{"type":"string","example":"dp.said.bAqhcVzrhy5cRHkOlNTc0Ve6w5NUDCpcutm8vGE9myi"},"expires_at":{"type":"string","example":"2025-01-17T16:46:46.171Z"}}}}}}},"deprecated":false,"security":[]}},"/v3/me":{"get":{"summary":"Me","description":"Get information about a token","operationId":"auth-me","responses":{"200":{"description":"200","content":{"application/json":{"examples":{"Result":{"value":"{\n  \"slug\": \"5ba6e0fd-a80a-4c39-9e85-3d5230d44e62\",\n  \"name\": \"Doppler-Test\",\n  \"created_at\": \"2023-06-15T20:17:33.539Z\",\n  \"last_seen_at\": \"2023-06-16T17:09:16.079Z\",\n  \"type\": \"cli\",\n  \"token_preview\": \"dp.ct...b8aked\",\n  \"workplace\": {\n    \"slug\": \"2faa85f6610102d983522\",\n    \"name\": \"Doppler University\"\n  }\n}"}},"schema":{"type":"object","properties":{"slug":{"type":"string","example":"5ba6e0fd-a80a-4c39-9e85-3d5230d44e62"},"name":{"type":"string","example":"Doppler-Test"},"created_at":{"type":"string","example":"2023-06-15T20:17:33.539Z"},"last_seen_at":{"type":"string","example":"2023-06-16T17:09:16.079Z"},"type":{"type":"string","example":"cli"},"token_preview":{"type":"string","example":"dp.ct...b8aked"},"workplace":{"type":"object","properties":{"slug":{"type":"string","example":"2faa85f6610102d983522"},"name":{"type":"string","example":"Doppler University"}}},"principal":{"type":"object","properties":{"type":{"type":"string"},"slug":{"type":"string"}}}}}}}},"400":{"description":"400","content":{"application/json":{"examples":{"Result":{"value":"{}"}},"schema":{"type":"object","properties":{}}}}}},"deprecated":false}},"/v3/workplace/users/{workplace_user_id}":{"get":{"summary":"Workplace User","description":"Get a specific user in a workplace","operationId":"audit-get_user","parameters":[{"name":"workplace_user_id","in":"path","description":"The ID of the workplace user","schema":{"type":"string"},"required":true},{"name":"settings","in":"query","description":"If true, the api will return more information if the user has e.g. SAML enabled and/or Multi Factor Auth enabled","schema":{"type":"boolean"}}],"responses":{"200":{"description":"200","content":{"application/json":{"examples":{"Result":{"value":"{\n  \"workplace_user\": {\n    \"id\": \"9629f890-eb33-426c-8694-28ce363b44f0\",\n    \"access\": \"owner\",\n    \"created_at\": \"2021-01-08T02:43:20.524Z\",\n    \"user\": {\n      \"email\": \"ruud.visser@doppler.com\",\n      \"name\": \"Ruud Visser\",\n      \"username\": \"ruud\",\n      \"profile_image_url\": \"https://lh3.googleusercontent.com/a-/AOh14Ggx8--xAHCMfmrNwV3hVGWrwSicyaALmjvu5of1=s96-c\",\n      \"mfa_enabled\": false,\n      \"thirdparty_sso_enabled\": true,\n      \"saml_sso_enabled\": false\n    }\n  },\n  \"success\": true\n}"}},"schema":{"type":"object","properties":{"workplace_user":{"type":"object","properties":{"id":{"type":"string","example":"9629f890-eb33-426c-8694-28ce363b44f0"},"access":{"type":"string","example":"owner"},"created_at":{"type":"string","example":"2021-01-08T02:43:20.524Z"},"user":{"type":"object","properties":{"email":{"type":"string","example":"ruud.visser@doppler.com"},"name":{"type":"string","example":"Ruud Visser"},"username":{"type":"string","example":"ruud"},"profile_image_url":{"type":"string","example":"https://lh3.googleusercontent.com/a-/AOh14Ggx8--xAHCMfmrNwV3hVGWrwSicyaALmjvu5of1=s96-c"},"mfa_enabled":{"type":"boolean","example":false,"default":true},"thirdparty_sso_enabled":{"type":"boolean","example":true,"default":true},"saml_sso_enabled":{"type":"boolean","example":false,"default":true}}}}},"success":{"type":"boolean","example":true,"default":true}}}}}}},"deprecated":false}},"/v3/workplace/service_accounts/service_account/{service_account}/identities":{"get":{"description":"","operationId":"get_v3workplaceservice_accountsservice_account{service_account}identities","responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"object","properties":{"identities":{"type":"array","items":{"properties":{"slug":{"type":"string"},"name":{"type":"string"},"method":{"type":"string"},"config":{"type":"object","properties":{"discovery_url":{"type":"string"},"claims_type":{"type":"string","enum":["wildcard","exact"]},"claims":{"type":"object","properties":{"aud":{"type":"array","items":{"type":"string"}},"sub":{"type":"array","items":{"type":"string"}}}}}},"ttl_seconds":{"type":"integer","format":"int32","default":""},"created_at":{"type":"string"},"last_seen_at":{"type":"string"}},"type":"object"}},"success":{"type":"boolean","default":"true"}}}}}}},"parameters":[{"in":"path","name":"service_account","schema":{"type":"string"},"required":true},{"in":"query","name":"page","schema":{"type":"integer","default":"1","format":"int32"},"required":false},{"in":"query","name":"per_page","schema":{"type":"integer","default":"20","format":"int32"},"required":false}]},"post":{"description":"","operationId":"post_v3workplaceservice_accountsservice_account{service_account}identities","responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"object","properties":{"identity":{"type":"object","properties":{"slug":{"type":"string"},"name":{"type":"string"},"method":{"type":"string","enum":["oidc"]},"config":{"type":"object","properties":{"discovery_url":{"type":"string"},"claims_type":{"type":"string"},"claims":{"type":"object","properties":{"aud":{"type":"array","items":{"type":"string"}},"sub":{"type":"array","items":{"type":"string"}}}},"ttl_seconds":{"type":"integer","format":"int32"},"created_at":{"type":"string"},"last_seen_at":{"type":"string"}}}}}}}}}}},"parameters":[{"in":"path","name":"service_account","schema":{"type":"string"},"required":true}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string"},"method":{"type":"string","enum":["oidc"]},"config":{"type":"object","properties":{"discovery_url":{"type":"string"},"claims_type":{"type":"string","enum":["exact","wildcard"]},"claims":{"type":"object","properties":{"aud":{"type":"array","items":{"type":"string"}},"sub":{"type":"array","items":{"type":"string"}}},"required":["aud","sub"]}},"required":["discovery_url","claims_type","claims"]},"ttl_seconds":{"type":"integer","format":"int32"}},"required":["name","method","config","ttl_seconds"]}}}}}},"/v3/workplace/service_accounts/service_account/{service_account}/identities/identity/{identity}":{"get":{"description":"","operationId":"get_v3workplaceservice_accountsservice_account{service_account}identitiesidentity{identity}","responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"object","properties":{"identity":{"type":"object","properties":{"slug":{"type":"string"},"name":{"type":"string"},"method":{"type":"string","enum":["oidc"]},"config":{"type":"object","properties":{"discovery_url":{"type":"string"},"claims_type":{"type":"string","enum":["exact","wildcard"]},"claims":{"type":"object","properties":{"aud":{"type":"array","items":{"type":"string"}},"sub":{"type":"array","items":{"type":"string"}}}}}},"ttl_seconds":{"type":"integer","format":"int32"},"created_at":{"type":"string"},"last_seen_at":{"type":"string"}}}}}}}}},"parameters":[{"in":"path","name":"service_account","schema":{"type":"string"},"required":true},{"in":"path","name":"identity","schema":{"type":"string"},"required":true}]},"put":{"description":"","operationId":"put_v3workplaceservice_accountsservice_account{service_account}identitiesidentity{identity}","responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"object","properties":{"identity":{"type":"object","properties":{"slug":{"type":"string"},"name":{"type":"string"},"method":{"type":"string","enum":["oidc"]},"config":{"type":"object","properties":{"discovery_url":{"type":"string"},"claims_type":{"type":"string","enum":["wildcard","exact"]},"claims":{"type":"object","properties":{"aud":{"type":"array","items":{"type":"string"}},"sub":{"type":"array","items":{"type":"string"}}}}}},"ttl_seconds":{"type":"integer","format":"int32"},"created_at":{"type":"string"},"last_seen_at":{"type":"string"}}}}}}}}},"parameters":[{"in":"path","name":"service_account","schema":{"type":"string"},"required":true},{"in":"path","name":"identity","schema":{"type":"string"},"required":true}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string"},"method":{"type":"string","enum":["oidc"]},"config":{"type":"object","properties":{"discovery_url":{"type":"string"},"claims_type":{"type":"string","enum":["exact","wildcard"]},"claims":{"type":"object","properties":{"aud":{"type":"array","items":{"type":"string"}},"sub":{"type":"array","items":{"type":"string"}}},"required":["sub","aud"]}},"required":["discovery_url","claims_type","claims"]},"ttl_seconds":{"type":"integer","format":"int32"}},"required":["name","method","config","ttl_seconds"]}}}}},"delete":{"description":"","operationId":"delete_v3workplaceservice_accountsservice_account{service_account}identitiesidentity{identity}","responses":{"204":{"description":""}},"parameters":[{"in":"path","name":"service_account","schema":{"type":"string"},"required":true},{"in":"path","name":"identity","schema":{"type":"string"},"required":true}]}},"/v3/workplace/change_requests":{"get":{"description":"","operationId":"get_v3workplacechange_requests","responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"title":{"type":"string"},"status":{"type":"string","enum":["open","closed"]},"createdAt":{"type":"string","format":"date-time"},"createdBy":{"type":"object","properties":{"slug":{"type":"string"},"type":{"type":"string","enum":["User","ServiceAccount"]},"name":{"type":"string"},"isActive":{"type":"boolean"},"image":{"type":"string"}}},"units":{"type":"array","items":{"properties":{"id":{"type":"string"},"status":{"type":"string","enum":["draft","open","applied","canceled"]},"target":{"type":"object","properties":{"project":{"type":"object","properties":{"slug":{"type":"string"},"name":{"type":"string"}}},"environment":{"type":"object","properties":{"slug":{"type":"string"},"name":{"type":"string"}}},"config":{"type":"object","properties":{"slug":{"type":"string"},"name":{"type":"string"}}}}}},"type":"object"}},"assigned":{"type":"array","items":{"properties":{"type":{"type":"string","enum":["WorkplaceUser","ServiceAccount"]},"slug":{"type":"string"},"name":{"type":"string"},"email":{"type":"string"},"image":{"type":"string"}},"type":"object"}}}}}}}}},"parameters":[{"in":"query","name":"page","schema":{"type":"integer","default":"1"}},{"in":"query","name":"per_page","schema":{"type":"integer","default":"20"}},{"in":"query","name":"status","schema":{"type":"array","items":{"type":"string"}}},{"in":"query","name":"title","schema":{"type":"string"}}]},"post":{"description":"","operationId":"post_v3workplacechange_requests","responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"object","properties":{"changeRequest":{"type":"object","properties":{"id":{"type":"string"}}}}}}}}},"parameters":[],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"title":{"type":"string"},"description":{"type":"string"},"assigned":{"type":"array","items":{"properties":{"type":{"type":"string","enum":["WorkplaceUser","ServiceAccount"]},"slug":{"type":"string"}},"type":"object","required":["type","slug"]}},"units":{"type":"array","items":{"properties":{"action":{"type":"string","default":"create","enum":["create"]},"id":{"type":"string"},"target":{"type":"object","properties":{"project":{"type":"string"},"config":{"type":"string"}},"required":["project","config"]},"status":{"type":"string","default":"open","enum":["draft","open"]},"updates":{"type":"array","items":{"properties":{"name":{"type":"string"},"value":{"type":"string"},"shouldDelete":{"type":"boolean","description":"Whether to delete the secret from target config when applied"},"visType":{"type":"integer","description":"0 = masked, 1 = unmasked, 2 = restricted","enum":[0,1,2]},"valueType":{"type":"object","properties":{"type":{"type":"string"}}},"generationSettings":{"type":"object","properties":{}},"originalSecretUpdateName":{"type":"string"}},"type":"object","required":["name"]}}},"type":"object","required":["action","target","updates"]}}},"required":["title","assigned","units"]},"examples":{}}}}}},"/v3/workplace/change_requests/change_request/{change_request_id}":{"get":{"description":"","operationId":"get_v3workplacechange_requestschange_request{change_request_id}","responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"object","properties":{"changeRequest":{"type":"object","properties":{"id":{"type":"string"},"title":{"type":"string"},"description":{"type":"string"},"status":{"type":"string","enum":["open","closed"]},"createdAt":{"type":"string","format":"date-time"},"createdBy":{"type":"object","properties":{"slug":{"type":"string"},"type":{"type":"string","enum":["User","ServiceAccount"]},"name":{"type":"string"},"isActive":{"type":"boolean"},"image":{"type":"string"}}},"units":{"type":"array","items":{"properties":{"id":{"type":"string"},"status":{"type":"string","enum":["draft","open","canceled","applied"]},"target":{"type":"object","properties":{"project":{"type":"object","properties":{"slug":{"type":"string"},"name":{"type":"string"}}},"environment":{"type":"object","properties":{"slug":{"type":"string"},"name":{"type":"string"}}},"config":{"type":"object","properties":{"slug":{"type":"string"},"name":{"type":"string"}}}}},"applied":{"type":"object","properties":{"configLog":{"type":"object","properties":{"slug":{"type":"string"}}},"activityLog":{"type":"object","properties":{"slug":{"type":"string"}}}}},"createdAt":{"type":"string","format":"date-time"},"createdBy":{"type":"object","properties":{"slug":{"type":"string"},"type":{"type":"string","enum":["User","ServiceAccount"]},"name":{"type":"string"},"isActive":{"type":"boolean"},"image":{"type":"string"}}},"updates":{"type":"array","items":{"properties":{"name":{"type":"string"},"value":{"type":"string"},"shouldDelete":{"type":"boolean"},"visType":{"type":"integer","enum":[0,1,2],"description":"0 = masked, 1 = unmasked, 2 = restricted"},"valueType":{"type":"object","properties":{"type":{"type":"string"}}},"generationSettings":{"type":"object","properties":{}}},"type":"object"}}},"type":"object"}},"assigned":{"type":"array","items":{"properties":{"type":{"type":"string","description":"","enum":["WorkplaceUser","ServiceAccount"]},"slug":{"type":"string"},"name":{"type":"string"},"email":{"type":"string"},"image":{"type":"string"}},"type":"object"}}}}}}}}}},"parameters":[{"in":"path","name":"change_request_id","schema":{"type":"string"},"required":true},{"in":"query","name":"reveal","schema":{"type":"string"},"description":"Whether to reveal secret values. If defined, any value except \"false\" is treated as true"}]},"post":{"description":"","operationId":"put_v3workplacechange_requestschange_request{change_request_id}","responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"object","properties":{"changeRequest":{"type":"object","properties":{"id":{"type":"string"}}}}}}}}},"parameters":[{"in":"path","name":"change_request_id","schema":{"type":"string"},"required":true}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"title":{"type":"string"},"description":{"type":"string"},"assigned":{"type":"array","items":{"properties":{"type":{"type":"string","enum":["WorkplaceUser","ServiceAccount"]},"slug":{"type":"string"}},"type":"object","required":["slug","type"]}},"units":{"type":"array","items":{"properties":{"action":{"type":"string","description":"","enum":["create","update"]},"id":{"type":"string","description":""},"status":{"type":"string","description":"","enum":["draft","open"],"default":"open"},"updates":{"type":"array","items":{"properties":{"action":{"type":"string","default":"","enum":["upsert","delete"]},"name":{"type":"string"},"value":{"type":"string"},"shouldDelete":{"type":"boolean","default":"","description":"Whether to delete the secret from target config when applied"},"visType":{"type":"integer","enum":[0,1,2],"description":"0 = masked, 1 = unmasked, 2 = restricted"},"valueType":{"type":"object","properties":{"type":{"type":"string"}}},"generationSettings":{"type":"object","properties":{}},"originalSecretUpdateName":{"type":"string"}},"type":"object","required":["name"]}}},"type":"object","required":["action","updates"]}}}}}}}}},"/v3/workplace/change_requests/change_request/{change_request_id}/close":{"post":{"description":"","operationId":"post_v3workplacechange_requestschange_request{change_request_id}close","responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","default":"true"}}}}}}},"parameters":[{"in":"path","name":"change_request_id","schema":{"type":"string"},"required":true}]}},"/v3/workplace/change_requests/change_request/{change_request_id}/assignees":{"put":{"description":"","operationId":"post_v3workplacechange_requestschange_request{change_request_id}","responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"object","properties":{"assigned":{"type":"array","items":{"properties":{"type":{"type":"string","enum":["WorkplaceUser","ServiceAccount"]},"slug":{"type":"string"},"name":{"type":"string"},"email":{"type":"string"},"image":{"type":"string"}},"type":"object"}}}}}}}},"parameters":[{"in":"path","name":"change_request_id","schema":{"type":"string"},"required":true}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"assigned":{"type":"array","items":{"properties":{"type":{"type":"string","enum":["WorkplaceUser","ServiceAccount"]},"slug":{"type":"string"}},"type":"object","required":["type","slug"]}}},"required":["assigned"]}}}}}},"/v3/workplace/change_requests/change_request/{change_request_id}/units/unit/{unit_id}":{"get":{"description":"","operationId":"get_v3workplacechange_requestschange_request{change_request_id}unitsunit{unit_id}","responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"object","properties":{"unit":{"type":"object","properties":{"id":{"type":"string"},"status":{"type":"string","enum":["draft","open","canceled","applied"]},"target":{"type":"object","properties":{"project":{"type":"object","properties":{"slug":{"type":"string"},"name":{"type":"string"}}},"environment":{"type":"object","properties":{"slug":{"type":"string"},"name":{"type":"string"}}},"config":{"type":"object","properties":{"slug":{"type":"string"},"name":{"type":"string"}}}}},"applied":{"type":"object","properties":{"configLog":{"type":"object","properties":{"slug":{"type":"string"}}},"activityLog":{"type":"object","properties":{"slug":{"type":"string"}}}}},"createdAt":{"type":"string","format":"date-time"},"createdBy":{"type":"object","properties":{"slug":{"type":"string"},"type":{"type":"string","enum":["User","ServiceAccount"]},"name":{"type":"string"},"isActive":{"type":"boolean"},"image":{"type":"string"}}},"updates":{"type":"array","items":{"properties":{"name":{"type":"string"},"value":{"type":"string"},"shouldDelete":{"type":"boolean"},"visType":{"type":"integer","description":"0 = masked, 1 = unmasked, 2 = restricted","enum":[0,1,2]},"valueType":{"type":"object","properties":{"type":{"type":"string"}}},"generationSettings":{"type":"object","properties":{}}},"type":"object"}}}}}}}}}},"parameters":[{"in":"query","name":"reveal","schema":{"type":"string"},"description":"Whether to reveal secret values. If defined, any value except \"false\" is treated as true"},{"in":"path","name":"change_request_id","schema":{"type":"string"},"required":true},{"in":"path","name":"unit_id","schema":{"type":"string"},"required":true}]}},"/v3/workplace/change_requests/change_request/{change_request_id}/units/unit/{unit_id}/status":{"put":{"description":"","operationId":"post_v3workplacechange_requestschange_request{change_request_id}unitsunit{unit_id}status","responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"object","properties":{"unit":{"type":"object","properties":{"id":{"type":"string"},"status":{"type":"string","enum":["draft","open","canceled"]}}}}}}}}},"parameters":[{"in":"path","name":"change_request_id","schema":{"type":"string"},"required":true},{"in":"path","name":"unit_id","schema":{"type":"string"},"required":true}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"string","enum":["draft","open","canceled"]}},"required":["status"]}}}}}},"/v3/workplace/change_requests/change_request/{change_request_id}/units/unit/{unit_id}/review":{"post":{"description":"","operationId":"post_v3workplacechange_requestschange_request{change_request_id}unitsunit{unit_id}review","responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"object","properties":{"unit":{"type":"object","properties":{"id":{"type":"string"},"status":{"type":"string","enum":["draft","open","canceled"]}}}}}}}}},"parameters":[{"in":"path","name":"change_request_id","schema":{"type":"string"},"required":true},{"in":"path","name":"unit_id","schema":{"type":"string"},"required":true}]},"delete":{"description":"","operationId":"delete_v3workplacechange_requestschange_request{change_request_id}unitsunit{unit_id}review","responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"object","properties":{"unit":{"type":"object","properties":{"id":{"type":"string"},"status":{"type":"string","enum":["draft","open","canceled"]}}}}}}}}},"parameters":[{"in":"path","name":"change_request_id","schema":{"type":"string"},"required":true},{"in":"path","name":"unit_id","schema":{"type":"string"},"required":true}]}},"/v3/workplace/change_requests/change_request/{change_request_id}/units/unit/{unit_id}/apply":{"post":{"description":"","operationId":"post_v3workplacechange_requestschange_request{change_request_id}unitsunit{unit_id}apply","responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"object","properties":{"unit":{"type":"object","properties":{"id":{"type":"string"},"status":{"type":"string","enum":["applied"],"default":"applied"}}}}}}}}},"parameters":[{"in":"path","name":"change_request_id","schema":{"type":"string"},"required":true},{"in":"path","name":"unit_id","schema":{"type":"string"},"required":true}]}},"/v3/integrations/integration/members":{"get":{"description":"","responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"object","properties":{"members":{"type":"array","items":{"properties":{"type":{"type":"string","enum":["workplace_user","invite","group","service_account"]},"slug":{"type":"string"},"role":{"type":"object","properties":{"identifier":{"type":"string"}}}},"type":"object"}}}}}}}},"parameters":[{"in":"query","name":"integration","schema":{"type":"string"},"required":true,"description":"Integration slug"},{"in":"query","name":"page","schema":{"type":"integer","format":"int32","default":"1"}},{"in":"query","name":"per_page","schema":{"type":"integer","format":"int32","default":"20"}}],"operationId":"get_v3-integrations-integration-members","summary":"List"},"post":{"description":"","responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"object","properties":{"member":{"type":"object","properties":{"type":{"type":"string","enum":["workplace_user","invite","group","service_account"]},"slug":{"type":"string"},"role":{"type":"object","properties":{"identifier":{"type":"string"}}}}}}}}}}},"parameters":[{"in":"query","name":"integration","schema":{"type":"string"},"required":true,"description":"Integration slug"}],"operationId":"post_v3-integrations-integration-members","requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"type":{"type":"string","enum":["workplace_user","invite","group","service_account"]},"slug":{"type":"string"},"role":{"type":"string"}},"required":["type","slug","role"]}}}},"summary":"Add"}},"/v3/workplace/integrations/integration/members/member/{type}/{slug}":{"get":{"description":"","responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"object","properties":{"member":{"type":"object","properties":{"type":{"type":"string","enum":["workplace_user","invite","group","service_account"]},"slug":{"type":"string"},"role":{"type":"object","properties":{"identifier":{"type":"string"}}}}}}}}}}},"parameters":[{"in":"path","name":"type","schema":{"type":"string","enum":["workplace_user","invite","group","service_account"]},"required":true},{"in":"path","name":"slug","schema":{"type":"string"},"required":true,"description":"Member's slug"},{"in":"query","name":"integration","schema":{"type":"string"},"required":true,"description":"Integration slug"}],"operationId":"get_v3-workplace-integrations-integration-members-member-type-slug"}},"/v3/workplace/integrations/integration/members/{type}/{slug}":{"get":{"description":"","responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"object","properties":{"member":{"type":"object","properties":{"type":{"type":"string","enum":["workplace_user","invite","group","service_account"]},"slug":{"type":"string"},"role":{"type":"object","properties":{"identifier":{"type":"string"}}}}}}}}}}},"parameters":[{"in":"path","name":"type","schema":{"type":"string","enum":["workplace_user","invite","group","service_account"]},"required":true},{"in":"path","name":"slug","schema":{"type":"string"},"required":true,"description":"Member's slug"},{"in":"query","name":"integration","schema":{"type":"string"},"description":"Integration slug","required":true}],"operationId":"get_v3-workplace-integrations-integration-members-type-slug","summary":"Retrieve"},"delete":{"description":"","responses":{"204":{"description":""}},"parameters":[{"in":"path","name":"type","schema":{"type":"string","enum":["workplace_user","invite","group","service_account"]},"required":true},{"in":"path","name":"slug","schema":{"type":"string"},"required":true,"description":"Member's slug"},{"in":"query","name":"integration","schema":{"type":"string"},"required":true,"description":"Integration slug"}],"operationId":"delete_v3-workplace-integrations-integration-members-type-slug","summary":"Delete"}},"/v3/integrations/integration/members/{type}/{slug}":{"patch":{"description":"","responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"object","properties":{"member":{"type":"object","properties":{"type":{"type":"string","enum":["workplace_user","invite","group","service_account"]},"slug":{"type":"string"},"role":{"type":"object","properties":{"identifier":{"type":"string"}}}}}}}}}}},"parameters":[{"in":"path","name":"type","schema":{"type":"string","enum":["workplace_user","invite","group","service_account"]},"required":true},{"in":"path","name":"slug","schema":{"type":"string"},"required":true,"description":"Member's slug"},{"in":"query","name":"integration","schema":{"type":"string"},"description":"Integration slug","required":true}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"role":{"type":"string"}},"required":["role"]}}}},"operationId":"patch_v3-integrations-integration-members-type-slug","summary":"Update"}}},"x-readme":{"headers":[],"explorer-enabled":true,"proxy-enabled":false},"x-readme-fauxas":true}