Update a Google Integration

curl --request PATCH \
  --url https://wksusa1b2c3d.provisionr.app/api/v1/google/integrations/{integration} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "description": "<string>",
  "google_domain": "example.com",
  "google_subject_email": "[email protected]",
  "badge_id_profile_key": "<string>",
  "employee_id_profile_key": "<string>",
  "employee_alt_id_profile_key": "<string>",
  "manager_enabled": true,
  "manager_id_child_key": "<string>",
  "manager_id_parent_key": "<string>",
  "retention_days": 547
}
'

$headers=@{}
$headers.Add("Authorization", "Bearer <token>")
$headers.Add("Content-Type", "application/json")
$response = Invoke-WebRequest -Uri 'https://wksusa1b2c3d.provisionr.app/api/v1/google/integrations/{integration}' -Method PATCH -Headers $headers -ContentType 'application/json' -Body '{
  "description": "<string>",
  "google_domain": "example.com",
  "google_subject_email": "[email protected]",
  "badge_id_profile_key": "<string>",
  "employee_id_profile_key": "<string>",
  "employee_alt_id_profile_key": "<string>",
  "manager_enabled": true,
  "manager_id_child_key": "<string>",
  "manager_id_parent_key": "<string>",
  "retention_days": 547
}'

import requests

url = "https://wksusa1b2c3d.provisionr.app/api/v1/google/integrations/{integration}"

payload = {
    "description": "<string>",
    "google_domain": "example.com",
    "google_subject_email": "[email protected]",
    "badge_id_profile_key": "<string>",
    "employee_id_profile_key": "<string>",
    "employee_alt_id_profile_key": "<string>",
    "manager_enabled": True,
    "manager_id_child_key": "<string>",
    "manager_id_parent_key": "<string>",
    "retention_days": 547
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.patch(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'PATCH',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    description: '<string>',
    google_domain: 'example.com',
    google_subject_email: '[email protected]',
    badge_id_profile_key: '<string>',
    employee_id_profile_key: '<string>',
    employee_alt_id_profile_key: '<string>',
    manager_enabled: true,
    manager_id_child_key: '<string>',
    manager_id_parent_key: '<string>',
    retention_days: 547
  })
};

fetch('https://wksusa1b2c3d.provisionr.app/api/v1/google/integrations/{integration}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "id": "gwitg_01hq8xyzabc123def456ghi789",
  "state": "staged",
  "is_primary": true,
  "type": "demo",
  "description": "<string>",
  "google_customer_id": "C01234567",
  "google_domain": "example.com",
  "google_subject_email": "[email protected]",
  "badge_id_profile_key": "<string>",
  "employee_id_profile_key": "<string>",
  "employee_alt_id_profile_key": "<string>",
  "manager_enabled": true,
  "manager_id_child_key": "<string>",
  "manager_id_parent_key": "<string>",
  "retention_days": 123,
  "scope_workspace_group": "write",
  "scope_identity_group": "write",
  "scope_drive": "write",
  "sync_enabled": true,
  "metadata": [
    "<string>"
  ],
  "timestamp": {
    "created_at": "2025-01-28T13:37:00Z",
    "updated_at": "2025-05-04T03:27:00Z",
    "deleted_at": null,
    "synced_at": "2023-11-07T05:31:56Z"
  },
  "count": {
    "credentials": 123,
    "directory_attributes": 123,
    "directory_dimensions": 123,
    "directory_identities": 123,
    "policy_conditions": 123
  },
  "included": {
    "credential": {
      "id": "gwcrd_01hq8xyzabc123def456ghi789",
      "integration_id": "gwitg_01hq8xyzabc123def456ghi789",
      "state": "staged",
      "oauth2_client_id": "<string>",
      "oauth2_client_email": "<string>",
      "oauth2_scopes": [
        "<string>"
      ],
      "use_platform_credentials": true,
      "notes": "<string>",
      "timestamp": {
        "created_at": "2025-01-28T13:37:00Z",
        "updated_at": "2025-05-04T03:27:00Z",
        "activated_at": "2025-03-14T15:07:00Z",
        "expires_at": null,
        "deleted_at": null
      },
      "links": [
        "<string>"
      ]
    }
  },
  "links": {
    "self": "<string>",
    "credential": "<string>",
    "credentials": "<string>",
    "directory_attributes": "<string>",
    "directory_dimensions": "<string>",
    "directory_identities": "<string>",
    "policy_conditions": "<string>"
  }
}

{
  "message": "<string>"
}

{
  "message": "<string>"
}

{
  "message": "<string>"
}

{
  "message": "<string>",
  "errors": {}
}

PATCH

google

integrations

{integration}

Update a Google Integration

curl --request PATCH \
  --url https://wksusa1b2c3d.provisionr.app/api/v1/google/integrations/{integration} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "description": "<string>",
  "google_domain": "example.com",
  "google_subject_email": "[email protected]",
  "badge_id_profile_key": "<string>",
  "employee_id_profile_key": "<string>",
  "employee_alt_id_profile_key": "<string>",
  "manager_enabled": true,
  "manager_id_child_key": "<string>",
  "manager_id_parent_key": "<string>",
  "retention_days": 547
}
'

$headers=@{}
$headers.Add("Authorization", "Bearer <token>")
$headers.Add("Content-Type", "application/json")
$response = Invoke-WebRequest -Uri 'https://wksusa1b2c3d.provisionr.app/api/v1/google/integrations/{integration}' -Method PATCH -Headers $headers -ContentType 'application/json' -Body '{
  "description": "<string>",
  "google_domain": "example.com",
  "google_subject_email": "[email protected]",
  "badge_id_profile_key": "<string>",
  "employee_id_profile_key": "<string>",
  "employee_alt_id_profile_key": "<string>",
  "manager_enabled": true,
  "manager_id_child_key": "<string>",
  "manager_id_parent_key": "<string>",
  "retention_days": 547
}'

import requests

url = "https://wksusa1b2c3d.provisionr.app/api/v1/google/integrations/{integration}"

payload = {
    "description": "<string>",
    "google_domain": "example.com",
    "google_subject_email": "[email protected]",
    "badge_id_profile_key": "<string>",
    "employee_id_profile_key": "<string>",
    "employee_alt_id_profile_key": "<string>",
    "manager_enabled": True,
    "manager_id_child_key": "<string>",
    "manager_id_parent_key": "<string>",
    "retention_days": 547
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.patch(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'PATCH',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    description: '<string>',
    google_domain: 'example.com',
    google_subject_email: '[email protected]',
    badge_id_profile_key: '<string>',
    employee_id_profile_key: '<string>',
    employee_alt_id_profile_key: '<string>',
    manager_enabled: true,
    manager_id_child_key: '<string>',
    manager_id_parent_key: '<string>',
    retention_days: 547
  })
};

fetch('https://wksusa1b2c3d.provisionr.app/api/v1/google/integrations/{integration}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "id": "gwitg_01hq8xyzabc123def456ghi789",
  "state": "staged",
  "is_primary": true,
  "type": "demo",
  "description": "<string>",
  "google_customer_id": "C01234567",
  "google_domain": "example.com",
  "google_subject_email": "[email protected]",
  "badge_id_profile_key": "<string>",
  "employee_id_profile_key": "<string>",
  "employee_alt_id_profile_key": "<string>",
  "manager_enabled": true,
  "manager_id_child_key": "<string>",
  "manager_id_parent_key": "<string>",
  "retention_days": 123,
  "scope_workspace_group": "write",
  "scope_identity_group": "write",
  "scope_drive": "write",
  "sync_enabled": true,
  "metadata": [
    "<string>"
  ],
  "timestamp": {
    "created_at": "2025-01-28T13:37:00Z",
    "updated_at": "2025-05-04T03:27:00Z",
    "deleted_at": null,
    "synced_at": "2023-11-07T05:31:56Z"
  },
  "count": {
    "credentials": 123,
    "directory_attributes": 123,
    "directory_dimensions": 123,
    "directory_identities": 123,
    "policy_conditions": 123
  },
  "included": {
    "credential": {
      "id": "gwcrd_01hq8xyzabc123def456ghi789",
      "integration_id": "gwitg_01hq8xyzabc123def456ghi789",
      "state": "staged",
      "oauth2_client_id": "<string>",
      "oauth2_client_email": "<string>",
      "oauth2_scopes": [
        "<string>"
      ],
      "use_platform_credentials": true,
      "notes": "<string>",
      "timestamp": {
        "created_at": "2025-01-28T13:37:00Z",
        "updated_at": "2025-05-04T03:27:00Z",
        "activated_at": "2025-03-14T15:07:00Z",
        "expires_at": null,
        "deleted_at": null
      },
      "links": [
        "<string>"
      ]
    }
  },
  "links": {
    "self": "<string>",
    "credential": "<string>",
    "credentials": "<string>",
    "directory_attributes": "<string>",
    "directory_dimensions": "<string>",
    "directory_identities": "<string>",
    "policy_conditions": "<string>"
  }
}

{
  "message": "<string>"
}

{
  "message": "<string>"
}

{
  "message": "<string>"
}

{
  "message": "<string>",
  "errors": {}
}

Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

integration

string

required

Google Integration ID

Body

application/json

UpdateGoogleIntegrationRequestData

type

enum<string>

The environment type for the Google integration. This is for internal cosmetic reference only


`demo` Demo Environment with Seeded Industry Data
`sandbox` Sandbox and Experiment Environment
`development` Local Development Environment
`testing` Automated or Unit Environment
`staging` Staging or User Acceptance Testing Environment
`production` Production Environment
`unknown` New Environment (Not Configured Yet)

Available options:

demo,

sandbox,

development,

testing,

staging,

production,

unknown

description

string

A description for the Google Integration. This is for reference only and has no effect on functionality

Maximum string length: 1000

google_domain

string

The Google Workspace primary domain

Maximum string length: 255

Example:

"example.com"

google_subject_email

string

The email address of the service account subject (domain-wide delegation)

Maximum string length: 255

Example:

"[email protected]"

badge_id_profile_key

string | null

The user profile key for badge ID in Google Workspace Directory API user schema, if applicable

Maximum string length: 255

employee_id_profile_key

string | null

The user profile key for employee ID in Google Workspace Directory API user schema, if applicable

Maximum string length: 255

employee_alt_id_profile_key

string | null

The user profile key for alternative employee ID in Google Workspace Directory API user schema, if applicable

Maximum string length: 255

manager_enabled

boolean

Whether this integration handles manager relationships. If true, the integration will attempt to sync manager relationships based on the provided manager_id_child_key and manager_id_parent_key

manager_id_child_key

string | null

The user profile key for the child in Google Workspace Directory API user schema for manager relationships, if applicable. This is required if manager_enabled is true

Maximum string length: 255

manager_id_parent_key

string | null

The user profile key for the parent in Google Workspace Directory API user schema for manager relationships, if applicable. This is required if manager_enabled is true

Maximum string length: 255

retention_days

integer

The number of days to retain PII for users that have been deleted or deactivated in Google Workspace. After this period, user record PII fields will be deleted and replaced with ghost user data

Required range: 0 <= x <= 1095

scope_workspace_group

enum<string>

The OAUTH scopes authorized for Google Workspace Groups


`write` RW/Manage Group Members + RW/Manage Groups
`write_existing` RW/Manage Group Members + RO/View Groups
`read` RO/View Group Members + RO/View Groups
`none` No permissions granted

Available options:

write,

write_existing,

read,

none

scope_identity_group

enum<string>

The OAUTH scopes authorized for Google Identity Groups


`write` RW/Manage Group Members + RW/Manage Groups
`read` RO/View Group Members + RO/View Groups
`none` No permissions granted

Available options:

write,

read,

none

scope_drive

enum<string>

The OAUTH scopes authorized for Google Drive


`write` RW/Manage Shared Drives, Folders and Files
`read` RO/View Shared Drives, Folders and Files
`none` No permissions granted

Available options:

write,

read,

none

Response

GoogleIntegrationDetailedResponseData

string

required

Example:

"gwitg_01hq8xyzabc123def456ghi789"

state

enum<string>

required

The state of the integration


`staged` The record is staged and is only visible to administrators or in the API. Use the `activate` method during your change window.
`active` The record is active.
`expiring` The `expires_at` value is set in the future for the record. You can run the `activate` action to remove the scheduled expiration.
`expired` The `expires_at` value is in the past and the record was deactivated.
`deactivated` The record was deactivated manually by an administrator.

Available options:

staged,

active,

expiring,

expired,

deactivated

is_primary

boolean

required

Whether this is the primary integration and Identity Provider single source of truth for the organization. This is used to manage the lifecycle of Directory Users. Additional integrations can enrich user profile data, but only the primary integration will be used to create, update, or deactivate Directory Users

type

enum<string>

required

The environment type for the Google integration. This is for internal cosmetic reference only


`demo` Demo Environment with Seeded Industry Data
`sandbox` Sandbox and Experiment Environment
`development` Local Development Environment
`testing` Automated or Unit Environment
`staging` Staging or User Acceptance Testing Environment
`production` Production Environment
`unknown` New Environment (Not Configured Yet)

Available options:

demo,

sandbox,

development,

testing,

staging,

production,

unknown

description

string | null

required

A description for the Google Integration. This is for reference only and has no effect on functionality

google_customer_id

string

required

The Google Workspace customer ID

Example:

"C01234567"

google_domain

string | null

required

The Google Workspace primary domain

Example:

"example.com"

google_subject_email

string | null

required

The email address of the service account subject

Example:

"[email protected]"

badge_id_profile_key

string | null

required

The user profile key for badge ID in Google Workspace Directory API user schema, if applicable

employee_id_profile_key

string | null

required

The user profile key for employee ID in Google Workspace Directory API user schema, if applicable

employee_alt_id_profile_key

string | null

required

The user profile key for alternative employee ID in Google Workspace Directory API user schema, if applicable

manager_enabled

boolean

required

Whether this integration handles manager relationships. If true, the integration will attempt to sync manager relationships based on the provided manager_id_child_key and manager_id_parent_key

manager_id_child_key

string | null

required

The user profile key for the child in Google Workspace Directory API user schema for manager relationships, if applicable. This is only used if manager_enabled is true

manager_id_parent_key

string | null

required

The user profile key for the parent in Google Workspace Directory API user schema for manager relationships, if applicable. This is only used if manager_enabled is true

retention_days

integer

required

The number of days to retain PII for users that have been deleted or deactivated in Google Workspace. After this period, user record PII fields will be deleted and replaced with ghost user data

scope_workspace_group

enum<string>

required

The OAUTH scopes authorized for Google Workspace Groups


`write` RW/Manage Group Members + RW/Manage Groups
`write_existing` RW/Manage Group Members + RO/View Groups
`read` RO/View Group Members + RO/View Groups
`none` No permissions granted

Available options:

write,

write_existing,

read,

none

scope_identity_group

enum<string>

required

The OAUTH scopes authorized for Google Identity Groups


`write` RW/Manage Group Members + RW/Manage Groups
`read` RO/View Group Members + RO/View Groups
`none` No permissions granted

Available options:

write,

read,

none

scope_drive

enum<string>

required

The OAUTH scopes authorized for Google Drive


`write` RW/Manage Shared Drives, Folders and Files
`read` RO/View Shared Drives, Folders and Files
`none` No permissions granted

Available options:

write,

read,

none

sync_enabled

boolean

required

Whether this integration is synced automatically on a schedule. If false, the integration can only be synced manually

metadata

string[] | null

required

Custom metadata key-value pairs for this integration

timestamp

IntegrationTimestampResponseData · object

required

The timestamps for the integration record

Show child attributes

count

object

required

Count of related records

Show child attributes

included

object

required

Included related resources

Show child attributes

links

object

required

API hyperlinks related to the record

Show child attributes

Getting Started

Endpoints

Update a Google Integration

Authorizations

Path Parameters

Body

Response