TABLE OF CONTENTS

• API Setup
• Business Use Case
• Authentication
• Endpoint
• Request
  • Body
• Response
• Not the API you're looking for?

API Setup

Choose your Host Region to have the documentation adapt to your use case.

Business Use Case

You can use this API to deactivate Users in CustomerGauge. This is especially useful when you're using our Single Sign On, and you'd like to synchronise deactivating users in both your Identity Provider as well as CustomerGauge.

Authentication

OAuth2 Authentication is used to connect to this API. Once you've created your Connected App, you can acquire a Bearer Access Token by calling our OAuth2/Token API:

curl -X POST -H "Content-Type: application/x-www-form-urlencoded"
-d "grant_type=client_credentials&client_id={{ Client ID }}&client_secret={{ Client Secret }}"
https://auth.{{ apiRegion }}.customergauge.com/oauth2/token

The acquired Bearer Access Token is used in the Authorization header in your API request.

Note: The Access Token is only valid for up to 1 hour. Save the Access Token temporarily when calling the API multiple times in a row, or obtain a fresh Access Token before calling the API.

Endpoint

Endpoint URL

https://api.{{ apiRegion }}.customergauge.com/v5/user-manager/users/disable

Request

Body

To deactivate a user, you should pass the user's email address in JSON in the Body of the Request.

{
    "email": "john.doe@example.com"
}

Response

{
    "message": "Unauthenticated."
}

{
    "message": "No query results for model [Library\\Eloquent\\Master\\User]."
}

{
    "message": "The given data was invalid.",
    "errors": {
        "configuration": [
            "The configuration field is required."
        ]
    }
}

Not the API you're looking for?

Get an overview of our APIs here.