Skip to main content
Server path: /doppler-workplace | Type: Application | PCID required: Yes

Tools

ToolDescription
doppler_workplace_audit_get_userWorkplace User
doppler_workplace_delete_v3workplaceservice_accountsservice_account_service_account_identitiesidentity_identityDELETE /v3/workplace/service_accounts/service_account/{service_account}/identities/identity/{identity}
doppler_workplace_getRetrieve
doppler_workplace_get_v3workplaceservice_accountsservice_account_service_account_identitiesGET /v3/workplace/service_accounts/service_account/{service_account}/identities
doppler_workplace_get_v3workplaceservice_accountsservice_account_service_account_identitiesidentity_identityGET /v3/workplace/service_accounts/service_account/{service_account}/identities/identity/{identity}
doppler_workplace_groups_add_memberAdd Member
doppler_workplace_groups_createCreate
doppler_workplace_groups_deleteDelete
doppler_workplace_groups_delete_memberDelete Member
doppler_workplace_groups_getRetrieve
doppler_workplace_groups_listList
doppler_workplace_groups_updateUpdate
doppler_workplace_invites_listList
doppler_workplace_post_v3workplaceservice_accountsservice_account_service_account_identitiesPOST /v3/workplace/service_accounts/service_account/{service_account}/identities
doppler_workplace_put_v3workplaceservice_accountsservice_account_service_account_identitiesidentity_identityPUT /v3/workplace/service_accounts/service_account/{service_account}/identities/identity/{identity}
doppler_workplace_retrieve_memberRetrieve Member
doppler_workplace_roles_createCreate
doppler_workplace_roles_deleteDelete
doppler_workplace_roles_getRetrieve
doppler_workplace_roles_listList
doppler_workplace_roles_list_permissionsList Permissions
doppler_workplace_roles_updateUpdate
doppler_workplace_service_account_tokens_createCreate
doppler_workplace_service_account_tokens_deleteDelete
doppler_workplace_service_account_tokens_getRetrieve
doppler_workplace_service_account_tokens_listList
doppler_workplace_service_accounts_createCreate
doppler_workplace_service_accounts_deleteDelete
doppler_workplace_service_accounts_getRetrieve
doppler_workplace_service_accounts_listList
doppler_workplace_service_accounts_updateUpdate
doppler_workplace_updateUpdate
doppler_workplace_users_getRetrieve
doppler_workplace_users_listList
doppler_workplace_users_updateUpdate

doppler_workplace_audit_get_user

Workplace User Parameters:
ParameterTypeRequiredDefaultDescription
workplace_user_idstringYesThe ID of the workplace user
settingsbooleanNoIf 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:
ParameterTypeRequiredDefaultDescription
service_accountstringYesService Account
identitystringYesThe identity value

doppler_workplace_get

Retrieve

doppler_workplace_get_v3workplaceservice_accountsservice_account_service_account_identities

GET /v3/workplace/service_accounts/service_account/{service_account}/identities Parameters:
ParameterTypeRequiredDefaultDescription
service_accountstringYesService Account
pageintegerNoPage number for pagination
per_pageintegerNoNumber 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:
ParameterTypeRequiredDefaultDescription
service_accountstringYesService Account
identitystringYesThe identity value

doppler_workplace_groups_add_member

Add Member Parameters:
ParameterTypeRequiredDefaultDescription
slugstringYesThe group’s slug
typestringYesThe type value

doppler_workplace_groups_create

Create Parameters:
ParameterTypeRequiredDefaultDescription
default_project_rolestringNoIdentifier of the project role
namestringYesThe name value

doppler_workplace_groups_delete

Delete Parameters:
ParameterTypeRequiredDefaultDescription
slugstringYesThe group’s slug

doppler_workplace_groups_delete_member

Delete Member Parameters:
ParameterTypeRequiredDefaultDescription
slugstringYesThe group’s slug
typestringYesThe type value
member_slugstringYesThe member’s slug

doppler_workplace_groups_get

Retrieve Parameters:
ParameterTypeRequiredDefaultDescription
slugstringYesThe group’s slug

doppler_workplace_groups_list

List Parameters:
ParameterTypeRequiredDefaultDescription
pageintegerNoPage number for pagination
per_pageintegerNoNumber of results per page

doppler_workplace_groups_update

Update Parameters:
ParameterTypeRequiredDefaultDescription
slugstringYesThe group’s slug
default_project_rolestringNoIdentifier of the project role
namestringNoThe name value

doppler_workplace_invites_list

List Parameters:
ParameterTypeRequiredDefaultDescription
pageintegerNoPage number for pagination
per_pageintegerNoNumber of results per page

doppler_workplace_post_v3workplaceservice_accountsservice_account_service_account_identities

POST /v3/workplace/service_accounts/service_account/{service_account}/identities Parameters:
ParameterTypeRequiredDefaultDescription
service_accountstringYesService Account
configobjectYesThe config value
methodstringYesThe method value
namestringYesThe name value
ttl_secondsintegerYesTtl Seconds

doppler_workplace_put_v3workplaceservice_accountsservice_account_service_account_identitiesidentity_identity

PUT /v3/workplace/service_accounts/service_account/{service_account}/identities/identity/{identity} Parameters:
ParameterTypeRequiredDefaultDescription
service_accountstringYesService Account
identitystringYesThe identity value
configobjectNoThe config value
methodstringNoThe method value
namestringNoThe name value
ttl_secondsintegerNoTtl Seconds

doppler_workplace_retrieve_member

Retrieve Member Parameters:
ParameterTypeRequiredDefaultDescription
group_slugstringYesThe group’s slug
member_typestringYesMember Type
member_slugstringYesThe member’s slug

doppler_workplace_roles_create

Create Parameters:
ParameterTypeRequiredDefaultDescription
namestringYesThe name of the role
permissionsstring[]YesAn 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:
ParameterTypeRequiredDefaultDescription
rolestringYesThe role’s unique identifier

doppler_workplace_roles_get

Retrieve Parameters:
ParameterTypeRequiredDefaultDescription
rolestringYesThe role’s unique identifier

doppler_workplace_roles_list

List

doppler_workplace_roles_list_permissions

List Permissions

doppler_workplace_roles_update

Update Parameters:
ParameterTypeRequiredDefaultDescription
rolestringYesThe role’s unique identifier, which is the initial name the role was given
namestringNoThe name of the role
permissionsstring[]NoAn 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:
ParameterTypeRequiredDefaultDescription
service_accountstringYesSlug of the service account
expires_atstringNoThe datetime at which the API token should expire. If not provided, the API token will remain vaild indefinitely unless manually revoked
namestringNoThe display name of the API token

doppler_workplace_service_account_tokens_delete

Delete Parameters:
ParameterTypeRequiredDefaultDescription
service_accountstringYesSlug of the service account
api_tokenstringYesSlug of the API token

doppler_workplace_service_account_tokens_get

Retrieve Parameters:
ParameterTypeRequiredDefaultDescription
service_accountstringYesSlug of the service account
api_tokenstringYesSlug of the API token

doppler_workplace_service_account_tokens_list

List Parameters:
ParameterTypeRequiredDefaultDescription
pageintegerNoPage number for pagination
per_pageintegerNoNumber of results per page
service_accountstringYesSlug of the service account

doppler_workplace_service_accounts_create

Create Parameters:
ParameterTypeRequiredDefaultDescription
namestringNoThe name value
workplace_roleobjectNoYou may provide an identifier OR permissions, but not both

doppler_workplace_service_accounts_delete

Delete Parameters:
ParameterTypeRequiredDefaultDescription
slugstringYesSlug of the service account

doppler_workplace_service_accounts_get

Retrieve Parameters:
ParameterTypeRequiredDefaultDescription
slugstringYesSlug of the service account

doppler_workplace_service_accounts_list

List Parameters:
ParameterTypeRequiredDefaultDescription
pageintegerNoPage number for pagination
per_pageintegerNoNumber of results per page

doppler_workplace_service_accounts_update

Update Parameters:
ParameterTypeRequiredDefaultDescription
slugstringYesSlug of the service account
namestringNoThe name value
workplace_roleobjectNoYou may provide an identifier OR permissions, but not both

doppler_workplace_update

Update Parameters:
ParameterTypeRequiredDefaultDescription
billing_emailstringNoBilling Email
namestringNoWorkplace name
security_emailstringNoSecurity Email

doppler_workplace_users_get

Retrieve Parameters:
ParameterTypeRequiredDefaultDescription
slugstringYesThe slug of the workplace user

doppler_workplace_users_list

List Parameters:
ParameterTypeRequiredDefaultDescription
pageintegerNoThe page of users to fetch
emailstringNoFilter results to only include the user with the provided email address

doppler_workplace_users_update

Update Parameters:
ParameterTypeRequiredDefaultDescription
slugstringYesThe slug of the workplace user.
accessstringNoThe identifier of the workplace role. E.g., owner, collaborator, etc.