/doppler-workplace | Type: Application | PCID required: Yes
Tools
doppler_workplace_audit_get_user
Workplace User Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
workplace_user_id | string | Yes | — | The ID of the workplace user |
settings | boolean | No | — | If true, the api will return more information if the user has e.g. SAML enabled and/or Multi Factor Auth enabled |
doppler_workplace_delete_v3workplaceservice_accountsservice_account_service_account_identitiesidentity_identity
DELETE /v3/workplace/service_accounts/service_account/{service_account}/identities/identity/{identity} Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
service_account | string | Yes | — | Service Account |
identity | string | Yes | — | The identity value |
doppler_workplace_get
Retrievedoppler_workplace_get_v3workplaceservice_accountsservice_account_service_account_identities
GET /v3/workplace/service_accounts/service_account/{service_account}/identities Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
service_account | string | Yes | — | Service Account |
page | integer | No | — | Page number for pagination |
per_page | integer | No | — | Number of results per page |
doppler_workplace_get_v3workplaceservice_accountsservice_account_service_account_identitiesidentity_identity
GET /v3/workplace/service_accounts/service_account/{service_account}/identities/identity/{identity} Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
service_account | string | Yes | — | Service Account |
identity | string | Yes | — | The identity value |
doppler_workplace_groups_add_member
Add Member Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
slug | string | Yes | — | The group’s slug |
type | string | Yes | — | The type value |
doppler_workplace_groups_create
Create Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
default_project_role | string | No | — | Identifier of the project role |
name | string | Yes | — | The name value |
doppler_workplace_groups_delete
Delete Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
slug | string | Yes | — | The group’s slug |
doppler_workplace_groups_delete_member
Delete Member Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
slug | string | Yes | — | The group’s slug |
type | string | Yes | — | The type value |
member_slug | string | Yes | — | The member’s slug |
doppler_workplace_groups_get
Retrieve Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
slug | string | Yes | — | The group’s slug |
doppler_workplace_groups_list
List Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
page | integer | No | — | Page number for pagination |
per_page | integer | No | — | Number of results per page |
doppler_workplace_groups_update
Update Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
slug | string | Yes | — | The group’s slug |
default_project_role | string | No | — | Identifier of the project role |
name | string | No | — | The name value |
doppler_workplace_invites_list
List Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
page | integer | No | — | Page number for pagination |
per_page | integer | No | — | Number of results per page |
doppler_workplace_post_v3workplaceservice_accountsservice_account_service_account_identities
POST /v3/workplace/service_accounts/service_account/{service_account}/identities Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
service_account | string | Yes | — | Service Account |
config | object | Yes | — | The config value |
method | string | Yes | — | The method value |
name | string | Yes | — | The name value |
ttl_seconds | integer | Yes | — | Ttl Seconds |
doppler_workplace_put_v3workplaceservice_accountsservice_account_service_account_identitiesidentity_identity
PUT /v3/workplace/service_accounts/service_account/{service_account}/identities/identity/{identity} Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
service_account | string | Yes | — | Service Account |
identity | string | Yes | — | The identity value |
config | object | No | — | The config value |
method | string | No | — | The method value |
name | string | No | — | The name value |
ttl_seconds | integer | No | — | Ttl Seconds |
doppler_workplace_retrieve_member
Retrieve Member Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
group_slug | string | Yes | — | The group’s slug |
member_type | string | Yes | — | Member Type |
member_slug | string | Yes | — | The member’s slug |
doppler_workplace_roles_create
Create Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
name | string | Yes | — | The name of the role |
permissions | string[] | Yes | — | 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 |
doppler_workplace_roles_delete
Delete Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
role | string | Yes | — | The role’s unique identifier |
doppler_workplace_roles_get
Retrieve Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
role | string | Yes | — | The role’s unique identifier |
doppler_workplace_roles_list
Listdoppler_workplace_roles_list_permissions
List Permissionsdoppler_workplace_roles_update
Update Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
role | string | Yes | — | The role’s unique identifier, which is the initial name the role was given |
name | string | No | — | The name of the role |
permissions | string[] | No | — | 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 |
doppler_workplace_service_account_tokens_create
Create Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
service_account | string | Yes | — | Slug of the service account |
expires_at | string | No | — | The datetime at which the API token should expire. If not provided, the API token will remain vaild indefinitely unless manually revoked |
name | string | No | — | The display name of the API token |
doppler_workplace_service_account_tokens_delete
Delete Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
service_account | string | Yes | — | Slug of the service account |
api_token | string | Yes | — | Slug of the API token |
doppler_workplace_service_account_tokens_get
Retrieve Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
service_account | string | Yes | — | Slug of the service account |
api_token | string | Yes | — | Slug of the API token |
doppler_workplace_service_account_tokens_list
List Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
page | integer | No | — | Page number for pagination |
per_page | integer | No | — | Number of results per page |
service_account | string | Yes | — | Slug of the service account |
doppler_workplace_service_accounts_create
Create Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
name | string | No | — | The name value |
workplace_role | object | No | — | You may provide an identifier OR permissions, but not both |
doppler_workplace_service_accounts_delete
Delete Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
slug | string | Yes | — | Slug of the service account |
doppler_workplace_service_accounts_get
Retrieve Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
slug | string | Yes | — | Slug of the service account |
doppler_workplace_service_accounts_list
List Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
page | integer | No | — | Page number for pagination |
per_page | integer | No | — | Number of results per page |
doppler_workplace_service_accounts_update
Update Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
slug | string | Yes | — | Slug of the service account |
name | string | No | — | The name value |
workplace_role | object | No | — | You may provide an identifier OR permissions, but not both |
doppler_workplace_update
Update Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
billing_email | string | No | — | Billing Email |
name | string | No | — | Workplace name |
security_email | string | No | — | Security Email |
doppler_workplace_users_get
Retrieve Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
slug | string | Yes | — | The slug of the workplace user |
doppler_workplace_users_list
List Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
page | integer | No | — | The page of users to fetch |
email | string | No | — | Filter results to only include the user with the provided email address |
doppler_workplace_users_update
Update Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
slug | string | Yes | — | The slug of the workplace user. |
access | string | No | — | The identifier of the workplace role. E.g., owner, collaborator, etc. |

