Help Center Home > APIs > Google Workspace API Attributes for User Lockout and Password Expiration

Google Workspace API Attributes for User Lockout and Password Expiration

Two attributes are available for the JumpCloud V2 API /gsuites/{id} endpoint.

The values for each attribute are suspend or maintain.

  • userLockoutAction: This attribute controls the action taken when a user is locked out of JumpCloud. If set to suspend, when a user is locked out of JumpCloud due to repeated failed login attempts, the user is suspended in Google Workspace and can no longer authenticate or receive emails. If set to maintain, when a user is locked out of JumpCloud, they remain in Google Workspace and can still authenticate and receive emails.
  • userPasswordExpirationAction: This attribute controls the action taken when a user’s JumpCloud account password expires. If set to suspend, when a user’s account password expires, the user is suspended in Google Workspace and can no longer authenticate or receive emails. If set to maintain, when a user’s password expires, they remain in Google Workspace and can still authenticate and receive emails.

Note:

The default setting for both attributes for Google Workspace integrations created after October 28, 2019 is maintain. It's important to note that this setting doesn't change settings for existing Google Workspace integrations; it only affects Google Workspace integrations created after October 28th, 2019. 

To see the values of the new attributes on a Google Workspace instance, do an HTTP GET request. To modify the new attributes, do an HTTP PATCH request.

Sample Requests

Pull a list of all directory connections to find your Google Workspace ID:

curl -X GET https://console.jumpcloud.com/api/v2/directories \
-H 'accept: application/json' \
-H 'content-type: application/json' \
-H 'x-api-key: {API Key}'

Pull information about your particular Google Workspace ID:

curl -X GET https://console.jumpcloud.com/api/v2/gsuites/{G Suite ID} \
-H 'Accept: application/json' \
-H 'Content-Type: application/json' \
-H 'x-api-key: {API Key}'

Set the attributes for lockout/expiration to “maintain”:

curl -X PATCH https://console.jumpcloud.com/api/v2/gsuites/{G Suite ID} \
-H 'Accept: application/json' \
-H 'Content-Type: application/json' \
-H 'x-api-key: {API Key}' \
-d '{"userLockoutAction": "maintain","userPasswordExpirationAction": "maintain"}'


Be sure to replace {API_KEY} and {G Suite_ID} with your own values and remember to remove the brackets { } around the values.

Back to Top

List IconIn this Article

Still Have Questions?

If you cannot find an answer to your question in our FAQ, you can always contact us.

Submit a Case