Create a Google Credential

curl --request POST \
  --url https://wksusa1b2c3d.provisionr.app/api/v1/google/credentials \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "integration_id": "gwitg_01hq8xyzabc123def456ghi789",
  "oauth2_client_id": "123456789012345678901",
  "oauth2_client_email": "[email protected]",
  "oauth2_private_key": "<string>",
  "use_platform_credentials": true,
  "notes": "<string>"
}
'

$headers=@{}
$headers.Add("Authorization", "Bearer <token>")
$headers.Add("Content-Type", "application/json")
$response = Invoke-WebRequest -Uri 'https://wksusa1b2c3d.provisionr.app/api/v1/google/credentials' -Method POST -Headers $headers -ContentType 'application/json' -Body '{
  "integration_id": "gwitg_01hq8xyzabc123def456ghi789",
  "oauth2_client_id": "123456789012345678901",
  "oauth2_client_email": "[email protected]",
  "oauth2_private_key": "<string>",
  "use_platform_credentials": true,
  "notes": "<string>"
}'

import requests

url = "https://wksusa1b2c3d.provisionr.app/api/v1/google/credentials"

payload = {
    "integration_id": "gwitg_01hq8xyzabc123def456ghi789",
    "oauth2_client_id": "123456789012345678901",
    "oauth2_client_email": "[email protected]",
    "oauth2_private_key": "<string>",
    "use_platform_credentials": True,
    "notes": "<string>"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    integration_id: 'gwitg_01hq8xyzabc123def456ghi789',
    oauth2_client_id: '123456789012345678901',
    oauth2_client_email: '[email protected]',
    oauth2_private_key: '<string>',
    use_platform_credentials: true,
    notes: '<string>'
  })
};

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

{
  "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": {
    "self": "<string>",
    "integration": "<string>",
    "credentials": "<string>"
  }
}

{
  "message": "<string>"
}

{
  "message": "<string>"
}

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

POST

google

credentials

Create a Google Credential

curl --request POST \
  --url https://wksusa1b2c3d.provisionr.app/api/v1/google/credentials \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "integration_id": "gwitg_01hq8xyzabc123def456ghi789",
  "oauth2_client_id": "123456789012345678901",
  "oauth2_client_email": "[email protected]",
  "oauth2_private_key": "<string>",
  "use_platform_credentials": true,
  "notes": "<string>"
}
'

$headers=@{}
$headers.Add("Authorization", "Bearer <token>")
$headers.Add("Content-Type", "application/json")
$response = Invoke-WebRequest -Uri 'https://wksusa1b2c3d.provisionr.app/api/v1/google/credentials' -Method POST -Headers $headers -ContentType 'application/json' -Body '{
  "integration_id": "gwitg_01hq8xyzabc123def456ghi789",
  "oauth2_client_id": "123456789012345678901",
  "oauth2_client_email": "[email protected]",
  "oauth2_private_key": "<string>",
  "use_platform_credentials": true,
  "notes": "<string>"
}'

import requests

url = "https://wksusa1b2c3d.provisionr.app/api/v1/google/credentials"

payload = {
    "integration_id": "gwitg_01hq8xyzabc123def456ghi789",
    "oauth2_client_id": "123456789012345678901",
    "oauth2_client_email": "[email protected]",
    "oauth2_private_key": "<string>",
    "use_platform_credentials": True,
    "notes": "<string>"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    integration_id: 'gwitg_01hq8xyzabc123def456ghi789',
    oauth2_client_id: '123456789012345678901',
    oauth2_client_email: '[email protected]',
    oauth2_private_key: '<string>',
    use_platform_credentials: true,
    notes: '<string>'
  })
};

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

{
  "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": {
    "self": "<string>",
    "integration": "<string>",
    "credentials": "<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.

Body

application/json

CreateGoogleCredentialRequestData

integration_id

string

required

The ID of the Google integration this credential belongs to

Pattern: ^gwitg_[0-9a-hjkmnp-tv-z]{26}$

Example:

"gwitg_01hq8xyzabc123def456ghi789"

oauth2_client_id

string

required

The OAuth2 client ID from the service account

Example:

"123456789012345678901"

oauth2_client_email

string

required

The OAuth2 client email from the service account

Example:

"[email protected]"

oauth2_private_key

string | null

The OAuth2 private key from the service account JSON key file

use_platform_credentials

boolean

Whether to use platform-managed credentials instead of customer-provided

notes

string

Optional notes about this credential

Maximum string length: 1000

Response

GoogleCredentialDetailedResponseData

string

required

Example:

"gwcrd_01hq8xyzabc123def456ghi789"

integration_id

string

required

Example:

"gwitg_01hq8xyzabc123def456ghi789"

state

enum<string>

required

The current lifecycle state of the credential


`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

oauth2_client_id

string

required

The OAuth2 client ID

oauth2_client_email

string

required

The OAuth2 client email

oauth2_scopes

string[] | null

required

The OAuth2 scopes

use_platform_credentials

boolean

required

Whether platform-managed credentials are used

notes

string | null

required

Optional notes

timestamp

TimestampStateData · object

required

The timestamps for the credential record

Show child attributes

links

object

required

API hyperlinks related to the record

Show child attributes

Getting Started

Endpoints

Create a Google Credential

Authorizations

Body

Response