providers_google_workspace_update

PUT 
/api/v3//providers/google_workspace/:id/

GoogleWorkspaceProvider Viewset

Request

Path Parameters

id integerrequired

A unique integer value identifying this Google Workspace Provider.

application/json

Body

required

name stringrequired

Possible values: non-empty

property_mappings uuid[]
property_mappings_group uuid[]

Property mappings used for group creation/updating.

delegated_subject emailrequired

Possible values: non-empty and <= 254 characters

credentials required
scopes string

Possible values: non-empty

exclude_users_service_account boolean
filter_group uuidnullable
user_delete_action OutgoingSyncDeleteAction (string)

Possible values: [do_nothing, delete, suspend]

group_delete_action OutgoingSyncDeleteAction (string)

Possible values: [do_nothing, delete, suspend]

default_group_email_domain stringrequired

Possible values: non-empty

Responses

200

application/json

Schema

Schema

pk ID (integer)required
name stringrequired
property_mappings uuid[]
property_mappings_group uuid[]

Property mappings used for group creation/updating.

component stringrequired

Get object component so that we know how to edit the object

assigned_backchannel_application_slug stringrequired

Internal application name, used in URLs.

assigned_backchannel_application_name stringrequired

Application's display Name.

verbose_name stringrequired

Return object's verbose_name

verbose_name_plural stringrequired

Return object's plural verbose_name

meta_model_name stringrequired

Return internal model name

delegated_subject emailrequired

Possible values: <= 254 characters

credentials required
scopes string
exclude_users_service_account boolean
filter_group uuidnullable
user_delete_action OutgoingSyncDeleteAction (string)

Possible values: [do_nothing, delete, suspend]

group_delete_action OutgoingSyncDeleteAction (string)

Possible values: [do_nothing, delete, suspend]

default_group_email_domain stringrequired

Example (from schema)

{
  "pk": 0,
  "name": "string",
  "property_mappings": [
    "3fa85f64-5717-4562-b3fc-2c963f66afa6"
  ],
  "property_mappings_group": [
    "3fa85f64-5717-4562-b3fc-2c963f66afa6"
  ],
  "component": "string",
  "assigned_backchannel_application_slug": "string",
  "assigned_backchannel_application_name": "string",
  "verbose_name": "string",
  "verbose_name_plural": "string",
  "meta_model_name": "string",
  "delegated_subject": "[email protected]",
  "credentials": {},
  "scopes": "string",
  "exclude_users_service_account": true,
  "filter_group": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "user_delete_action": "do_nothing",
  "group_delete_action": "do_nothing",
  "default_group_email_domain": "string"
}

400

application/json

Schema

Schema

non_field_errors string[]
code string

Example (from schema)

{
  "non_field_errors": [
    "string"
  ],
  "code": "string"
}

403

application/json

Schema

Schema

detail stringrequired
code string

Example (from schema)

{
  "detail": "string",
  "code": "string"
}

• curl
• python
• go
• nodejs
• ruby
• csharp
• php
• java
• powershell

• CURL

curl -L -X PUT '/api/v3/providers/google_workspace/:id/' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <TOKEN>' \
--data-raw '{
  "name": "string",
  "property_mappings": [
    "3fa85f64-5717-4562-b3fc-2c963f66afa6"
  ],
  "property_mappings_group": [
    "3fa85f64-5717-4562-b3fc-2c963f66afa6"
  ],
  "delegated_subject": "[email protected]",
  "credentials": {},
  "scopes": "string",
  "exclude_users_service_account": true,
  "filter_group": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "user_delete_action": "do_nothing",
  "group_delete_action": "do_nothing",
  "default_group_email_domain": "string"
}'

Request Collapse all

Base URL

/api/v3

Auth

Bearer Token

Parameters

id — pathrequired

Body required

{
  "name": "string",
  "property_mappings": [
    "3fa85f64-5717-4562-b3fc-2c963f66afa6"
  ],
  "property_mappings_group": [
    "3fa85f64-5717-4562-b3fc-2c963f66afa6"
  ],
  "delegated_subject": "[email protected]",
  "credentials": {},
  "scopes": "string",
  "exclude_users_service_account": true,
  "filter_group": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "user_delete_action": "do_nothing",
  "group_delete_action": "do_nothing",
  "default_group_email_domain": "string"
}