G Suite

Update existing G Suite

This endpoint allows updating some attributes of a G Suite.

Sample Request
curl -X PATCH https://console.jumpcloud.com/api/v2/gsuites/{GSUITE_ID} \
  -H 'Accept: application/json' \
  -H 'Content-Type: application/json' \
  -H 'x-api-key: {API_KEY}' \
  -d '{
    "userLockoutAction": "suspend",
    "userPasswordExpirationAction": "maintain"
  }'

Sample Request, set a default domain

curl -X PATCH https://console.jumpcloud.com/api/v2/gsuites/{GSUITE_ID} \
  -H 'Accept: application/json' \
  -H 'Content-Type: application/json' \
  -H 'x-api-key: {API_KEY}' \
  -d '{
    "defaultDomain": {
        "id": "{domainObjectID}"
      }
  }'

Sample Request, unset the default domain

curl -X PATCH https://console.jumpcloud.com/api/v2/gsuites/{GSUITE_ID} \
  -H 'Accept: application/json' \
  -H 'Content-Type: application/json' \
  -H 'x-api-key: {API_KEY}' \
  -d '{
    "defaultDomain": {}
  }'
patch/api/v2/gsuites/{id}

Request

Headers

x-org-idstring

Organization identifier that can be obtained from console settings.

Request body

idstring
userLockoutAction'suspend' | 'maintain'
userPasswordExpirationAction'suspend' | 'maintain' | 'remove_access'
namestring
groupsEnabledboolean
importFilterstring
organizationObjectIdstring byte

OrganizationObjectId is the object id of the organization that the account belongs to.

Response

idstring
userLockoutAction'suspend' | 'maintain'
userPasswordExpirationAction'suspend' | 'maintain' | 'remove_access'
namestring
groupsEnabledboolean
importFilterstring
organizationObjectIdstring byte

OrganizationObjectId is the object id of the organization that the account belongs to.

Changes

No recorded changes to this operation across all 1 revision of this API.