Retrieve User ID By User Name

This API fetches the Agent's User ID from the database for the given username.

Endpoint

Method: GET

URL: https://api.<region>.cloud.uniphore.com/ocms/v2/configuration/userId/{userName}

Request

curl -X GET "https://api.<region>.cloud.uniphore.com/ocms/v2/configuration/userId/auth0%7C643f8d821d16698950eb2695?environment=dev" -H "accept: */*" -H "Authorization: eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCIsImtpZCI6IkxYejBQYWVFRERuS3dfcjdkU2s2UyJ9.eyJodHRwczovL2FwaS51bmlwaG9yZS5jb20vZW1haWxfaWQiOiJ2aWR5YUB5b3BtYWlsLmNvbSIsImh0dHBzOi8vYXBpLnVuaXBob3JlLmNvbS9hdXRoMF9uYW1lIjoidmlkeWFAeW9wbWFpbC5jb20iLCJodHRwczovL2FwaS51bmlwaG9yZS5jb20vdXNlcl9pZCI6ImF1dGgwfDY0MmQ2NTQ5NDQ0Yzk1MTE0NmFhMmI0MiIsImh0dHBzOi8vYXBpLnVuaXBob3JlLmNvbS9yb2xlcyI6WyJpbnRlcmFjdF9hY2NvdW50X2FkbWluIiwidV9hZG1pbmlzdHJhdG9yIl0sImh0dHBzOi8vYXBpLnVuaXBob3JlLmNvbS91c2VyX21ldGFkYXRhIjp7ImNsaWVudF9pZCI6InZpZHlhQHlvcG1haWwuY29tIiwiZmlyc3ROYW1lIjoidmlkeWEiLCJsYXN0TmFtZSI6InNoYXJtYSIsInJlc3RyaWN0UHJvZHVjdGlvbkFjY2VzcyI6ZmFsc2V9LCJodHRwczovL2FwaS51bmlwaG9yZS5jb20vdGVuYW50IjoiYzVkNDViZDUtYzQyNi00ZDhjLTg0MTYtZTIxMjE1ZTE3Y2RmIiwiaXNzIjoiaHR0cHM6Ly9kZXYtZzJqNW11MnoudXMuYXV0aDAuY29tLyIsInN1YiI6ImF1dGgwfDY0MmQ2NTQ5NDQ0Yzk1MTE0NmFhMmI0MiIsImF1ZCI6WyJhcGkudW5pcGhvcmUuY29tIiwiaHR0cHM6Ly9kZXYtZzJqNW11MnoudXMuYXV0aDAuY29tL3VzZXJpbmZvIl0sImlhdCI6MTY4MDY5ODIzMCwiZXhwIjoxNjgxOTA3ODMwLCJhenAiOiJwZHRHaFhnQlpFcjZQc1g0WVhaNE55TDl5dnZ5a2FEeCIsInNjb3BlIjoib3BlbmlkIiwib3JnX2lkIjoib3JnX2VwRzdTaDRzeG1jRU9RQUYiLCJwZXJtaXNzaW9ucyI6WyJyZWFkOmV4cGVyaWVuY2VzIiwid3JpdGU6ZXhwZXJpZW5jZXMiXX0.Jx5TzN4vB9J-XTZdHkPx5IORK9ct0GRfCQ7sz_BiNNf3858_1u3MG1LtRuhnTTQX9pdA5gKxt8f5IFaNZUC5MAJSgDKT6fvrdT1cbzsti1ROwNb6wdBNiDB6RH0Fg4mczZydXsAVVEVF9BoTvCuvQ8SxbJSJdPgGWxoClZO3Pi2hhb71RNh1saQ7B-vloa9vy54MorNgZdcXbUK3KAWG09bdzdAG7x-y-BOsChz4n19mP59d7JmTwPEqBoLcVlkdyWdl5NhKLKex4ThDgjK1D70LccowkdqctcT9PlaJ00i3n7ex12J_vmTpFyUG1hXPmdsLJC9LoYssO-sohPEqCw"

Header Parameter

Parameter Name	Description	Data Type	Value
`Authorization`	Access token should be sent with all client requests. The access token helps the platform services to get the user information from auth0. You can pass user authorization token which is generated from auth0.	String	Bearer <token>

Parameter Name

Description

Data Type

Value

Authorization

Access token should be sent with all client requests. The access token helps the platform services to get the user information from auth0.

You can pass user authorization token which is generated from auth0.

String

Bearer <token>

Path Parameter

Parameter Name	Mandatory / Optional	Data Type	Description
`userName`	Mandatory	String	Auth0 ID

Query Parameter

Parameter Name	Mandatory / Optional	Data Type	Description
`environment`	Optional	String	Operating environment type. Three out-of-the-box environments are provided for each account: DEV TEST PROD

Response and Error Codes

Code	Response
200	Agent's user ID is successfully fetched from the database.
401	Authentication failed. This response code will be shown if any of the following scenarios occur: The provided token is not a valid JWT token. The access_token provided is not a valid token or has already expired. The user for whom the access_token was generated is not eligible (incorrect role) to use the API.
403	Forbidden. If you use the access token of other role, this response code will be shown.
500	Internal Server Error.

In this section:

Uniphore Customer Portal