JUjumpcloud
Providers
G Suite

List GSuite Accounts

This endpoint allows you to list all your g_suites accounts for a Providers primary organization.

Sample Request

curl -X GET https://console.jumpcloud.com/api/v2/providers/{provider_id}/g_suites \
  -H 'accept: application/json' \
  -H 'content-type: application/json' \
  -H 'x-org-id: -' \
  -H 'x-api-key: {API_KEY}'
get/api/v2/providers/{provider_id}/g_suites

Request

Path parameters

provider_idstring required

The ID of the provider

Query parameters

fieldsstring[]

The comma separated fields included in the returned records. If omitted, the default list of fields will be returned.

filterstring[]

A filter to apply to the query.

Filter structure: <field>:<operator>:<value>.

field = Populate with a valid field from an endpoint response.

operator = Supported operators are: eq, ne, gt, ge, lt, le, between, search, in. Note: v1 operators differ from v2 operators.

value = Populate with the value you want to search for. Is case sensitive. Supports wild cards.

EX: GET /api/v2/groups?filter=name:eq:Test+Group

limitinteger

The number of records to return at once. Limited to 100.

skipinteger

The offset into the records to return.

sortstring[]

The comma separated fields used to sort the collection. Default sort is ascending, prefix with - to sort descending.

Headers

x-org-idstring

Organization identifier that can be obtained from console settings.

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.