Chapter 1 Setting up oauth client

This chapter goes into the setting up of the oauth client for user provisioning.

Our default API documentation has additional material related to setting upOAuth.

Endpoint:

POST /v1/user/{user_id}/oauth-client

{}

Response:

{
    "Response": [
        {
            "Id": {
                "id": 789
            }
        }
    ]
}

---

Step 2: Read OAuth Client Details

Endpoint:

GET /v1/user/{user_id}/oauth-client/{client_id}

Response:

{
    "Response": [
        {
            "OauthClient": {
                "id": 789,
                "status": "ACTIVE",
                "display_name": null,
                "client_id": "client_abc123def456",
                "secret": "secret_xyz789uvw012",
                "callback_url": []
            }
        }
    ]
}

Fields:

Field	Type	Description
id	integer	Unique identifier for the OAuth client
status	string	Status (e.g., ACTIVE)
display_name	string	Human-readable name
client_id	string	OAuth client ID
secret	string	OAuth client secret
callback_url	array	Registered callback URLs

---

Step 3: Register OAuth Callback URL

Endpoint:

POST /v1/user/{user_id}/oauth-client/{client_id}/callback-url

{
    "url": "https://yourpartner.com/oauth/callback"
}

Response:

{
    "Response": [
        {
            "Id": {
                "id": 456
            }
        }
    ]
}

Parameter	Type	Required	Description
url	string	Yes	HTTPS callback URL to register

---

Step 4: Read Callback URL Details

Endpoint:

GET /v1/user/{user_id}/oauth-client/{client_id}/callback-url/{callback_url_id}

Response:

{
    "Response": [
        {
            "OauthCallbackUrl": {
                "id": 456,
                "created": "2025-08-13 14:45:20.123456",
                "updated": "2025-08-13 14:45:20.123456",
                "url": "https://yourpartner.com/oauth/callback"
            }
        }
    ]
}