PEC-Developer/Current/WebAPIs/Authentication - Revision history

WikiSysop: Created page with "{{ArticleUnstructured |Standalone=No |DisplayName=Authentication API }} ===Base path: /auth/v3===

2023-11-26T04:31:09Z

Created page with "{{ArticleUnstructured |Standalone=No |DisplayName=Authentication API }} ===Base path: /auth/v3===  <div class="web-api-post mw-collapsible mw-c..."

New page
{{ArticleUnstructured
|Standalone=No
|DisplayName=Authentication API
}}

===Base path: /auth/v3===


<div class="web-api-post mw-collapsible mw-collapsed">
{| class="web-api-introduction-table"
| style="width: 150px" | <div class="web-api-post-text"> POST </div>
| <div class="web-api-urlpath">/change-password</div>
<div class="web-api-summary">Change password</div>
|}
<div class="mw-collapsible-content">
<div class="web-api-description">Change the user's password.</div>

<div class="web-api-section-heading">Parameters</div>
{| class="web-api-parameters-table"
! Name !! Default !! Description !! Parameter Type !! Data Type !! Required
|-
| Authorization
| bearer
| The OAuth 2 bearer access token you received from /auth/v3/oauth/token. For example: <tt>Authorization: bearer a4b5da75-a584-4053-9227-0f0ab23ff06e</tt>
| header
| string
|
|-
| request
|
| Request
| body
|
| true
|-
| colspan=6 |
{|
| <source>
{
"data": {
"newPassword": "string",
"oldPassword": "string",
"userName": "string"
},
"operationId": "string"
}
</source>
|
{| class="web-api-body-table"
| colspan=2 | <div class="web-api-body-obj"> ChangePasswordOperation </div>
|-
| style="text-align:right;" | newPassword
| (string, required):
|-
| style="text-align:right;" | oldPassword
| (string, required):
|-
| style="text-align:right;" | userName
| (string, optional):
|-
| colspan=2 | <div class="web-api-body-obj"> ApiRequestOfChangePasswordOperation </div>
|-
| style="text-align:right;" | data
| (ChangePasswordOperation, required):
|-
| style="text-align:right;" | operationId
| (string, optional): Used for asynchronous operations to map request and response
|}
|}
|}
<div class="web-api-section-heading">Responses</div>
{| class="web-api-responses-table"
! Code !! Reason
|-
| 200
| Ok
|-
| colspan=2 |
{|
| <source>
{
"data": {
},
"errors": [
{
"status": {
"code": 0,
"detail": {
},
"message": "string"
}
}
],
"path": "string",
"status": {
"code": 0,
"detail": {
},
"message": "string"
}
}
</source>
|
{| class="web-api-body-table"
| colspan=2 | <div class="web-api-body-obj"> ResponseStatus </div>
|-
| style="text-align:right;" | code
| (integer):
|-
| style="text-align:right;" | detail
| (object):
|-
| style="text-align:right;" | message
| (string):
|-
| colspan=2 | <div class="web-api-body-obj"> ErrorResponse </div>
|-
| style="text-align:right;" | status
| (ResponseStatus):
|-
| colspan=2 | <div class="web-api-body-obj"> ErrorResponse </div>
|-
| style="text-align:right;" | data
| (object):
|-
| style="text-align:right;" | errors
| (array:ErrorResponse):
|-
| style="text-align:right;" | path
| (string):
|-
| style="text-align:right;" | status
| (ResponseStatus):
|}
|}
|-
| 403
| Unable to update password
|-
| 503
| Service unavailable
|}
<div class="web-api-section-heading">Usage</div>
<source lang="cURL">
curl -X POST
-H "x-api-key: your_API_key"
-H "Content-Type: application/json"
-d '{
"data": {
"newPassword": "string",
"oldPassword": "string",
"userName": "string"
},
"operationId": "string"
}'
"https://api-demo.com/auth/v3/change-password?"
</source>
</div>
</div>


<div class="web-api-get mw-collapsible mw-collapsed">
{| class="web-api-introduction-table"
| style="width: 150px" | <div class="web-api-get-text"> GET </div>
| <div class="web-api-urlpath">/jwt-userinfo</div>
<div class="web-api-summary">Get user information by access token. The information will be encoded as jwt and returned in 'X-GWS-User' header</div>
|}
<div class="mw-collapsible-content">
<div class="web-api-description">Get information about a user by their OAuth 2 access token.</div>
<div class="web-api-section-heading">Parameters</div>
{| class="web-api-parameters-table"
! Name !! Default !! Description !! Parameter Type !! Data Type !! Required
|-
| Authorization
|
| The OAuth 2 bearer access token. For example: <tt>Authorization: bearer a4b5da75-a584-4053-9227-0f0ab23ff06e</tt>
| header
| string
| true
|}
<div class="web-api-section-heading">Responses</div>
{| class="web-api-responses-table"
! Code !! Reason
|-
| 200
| Ok
|-
| colspan=2 |
{|
| <source>
{
"data": {
},
"errors": [
{
"status": {
"code": 0,
"detail": {
},
"message": "string"
}
}
],
"path": "string",
"status": {
"code": 0,
"detail": {
},
"message": "string"
}
}
</source>
|
{| class="web-api-body-table"
| colspan=2 | <div class="web-api-body-obj"> ResponseStatus </div>
|-
| style="text-align:right;" | code
| (integer):
|-
| style="text-align:right;" | detail
| (object):
|-
| style="text-align:right;" | message
| (string):
|-
| colspan=2 | <div class="web-api-body-obj"> ErrorResponse </div>
|-
| style="text-align:right;" | status
| (ResponseStatus):
|-
| colspan=2 | <div class="web-api-body-obj"> ApiResponse </div>
|-
| style="text-align:right;" | data
| (object):
|-
| style="text-align:right;" | errors
| (array:ErrorResponse):
|-
| style="text-align:right;" | path
| (string):
|-
| style="text-align:right;" | status
| (ResponseStatus):
|-
|}
|}
|}
<div class="web-api-section-heading">Usage</div>
<source lang="cURL">
curl -X GET
-H "x-api-key: your_API_key"
-H "Content-Type: application/json"

"https://api-demo.com/auth/v3/jwt-userinfo?"
</source>
</div>
</div>


<div class="web-api-get mw-collapsible mw-collapsed">
{| class="web-api-introduction-table"
| style="width: 150px" | <div class="web-api-get-text"> GET </div>
| <div class="web-api-urlpath">/oauth/authorize</div>
<div class="web-api-summary">Perform authorization</div>
|}
<div class="mw-collapsible-content">
<div class="web-api-description">Perform authorization for the Authorization Code Grant type, which is currently the only type supported by the Authentication API. For more information, see [https://tools.ietf.org/html/rfc6749#section-3.1 Authorization Endpoint]. <b>Note:</b> For the optional <tt>scope</tt> parameter, the API supports only the <tt></tt> value.</div>
<div class="web-api-section-heading">Parameters</div>
{| class="web-api-parameters-table"
! Name !! Default !! Description !! Parameter Type !! Data Type !! Required
|-
| Authorization
|
| Basic authorization. For example: <tt>Authorization: Basic Y3…MQ==</tt>
| header
| string
|
|-
| client_id
|
| The ID of the application or service that is registered as the client. You'll need to get this value from your Engage Cloud representative.
| query
| string
| true
|-
| hideTenant
| false
| Hide the <b>tenant</b> field in the UI for Authorization Code Grant.
| query
| boolean
|
|-
| redirect_uri
|
| The URI that you want users to be redirected to after entering valid credentials during an Implicit or Authorization Code grant. The Authentication API includes this as part of the URI it returns in the 'Location' header.
| query
| string
| true
|-
| response_type
|
| The response type to let the Authentication API know which grant flow you're using. Possible values are <tt>code</tt> for Authorization Code Grant or <tt>token</tt> for Implicit Grant. For more information about this parameter, see [https://datatracker.ietf.org/doc/html/rfc6749#section-3.1.1 Response Type].
| query
| string
| true
|-
| scope
|
| The scope of the access request. The Authentication API supports only the <tt></tt> value.
| query
| string
|
|}
<div class="web-api-section-heading">Responses</div>
{| class="web-api-responses-table"
! Code !! Reason
|-
| 302
| Found
|-
| colspan=2 |
{|
| <source>"string"</source>
|
|}
|-
| 401
| Unauthorized
|}
<div class="web-api-section-heading">Usage</div>
<source lang="cURL">
curl -X GET
-H "x-api-key: your_API_key"
-H "Content-Type: application/json"

"https://api-demo.com/auth/v3/oauth/authorize?client_id=string&hideTenant=true&redirect_uri=string&response_type=string&scope=string"
</source>
</div>
</div>


<div class="web-api-post mw-collapsible mw-collapsed">
{| class="web-api-introduction-table"
| style="width: 150px" | <div class="web-api-post-text"> POST </div>
| <div class="web-api-urlpath">/oauth/token</div>
<div class="web-api-summary">Retrieve access token</div>
|}
<div class="mw-collapsible-content">
<div class="web-api-description">Retrieve an access token for the Authorization Code Grant type, which is which is currently the only type supported by the Authentication API. For more information, see [https://tools.ietf.org/html/rfc6749 Token Endpoint]. <b>Note:</b> For the optional <tt>scope</tt> parameter, the API supports only the <tt></tt> value.</div>
<div class="web-api-section-heading">Parameters</div>
{| class="web-api-parameters-table"
! Name !! Default !! Description !! Parameter Type !! Data Type !! Required
|-
| Accept
|
| The media type the Authentication API should should use for the response. For example: <tt>Accept: application/x-www-form-urlencoded</tt>
| header
| string
|
|-
| Authorization
|
| Basic authorization. For example: <tt>Authorization: Basic Y3…MQ==</tt>
| header
| string
|
|-
| client_id
|
| The ID of the application or service that is registered as the client. You'll need to get this value from your Engage Cloud representative.
| formData
| string
|
|-
| code
|
| Authorization code, see [https://tools.ietf.org/html/rfc6749#section-4.1.3 Access Token Request] for details.
| formData
| string
|
|-
| grant_type
|
| The grant type you use to implement authentication.
| formData
| string
| true
|-
| password
|
| The agent's password.
| formData
| string
|
|-
| refresh_token
|
| See [https://datatracker.ietf.org/doc/html/rfc6749#section-1.5 Refresh Token] for details.
| formData
| string
|
|-
| scope
|
| The scope of the access request. The Authentication API supports only the <tt></tt> value.
| formData
| string
|
|-
| username
|
| The agent's username.
| formData
| string
|
|}
<div class="web-api-section-heading">Responses</div>
{| class="web-api-responses-table"
! Code !! Reason
|-
| 200
| Ok
|-
| colspan=2 |
{|
| <source>
{
"access_token": "string",
"expires_in": 0,
"refresh_token": "string",
"scope": "string",
"token_type": "string"
}
</source>
|
{| class="web-api-body-table"
| colspan=2 | <div class="web-api-body-obj"> DefaultOAuth2AccessToken </div>
|-
| style="text-align:right;" | access_token
| (string):
The access token.
|-
| style="text-align:right;" | expires_in
| (integer):
The time, in seconds, before the token expiration.
|-
| style="text-align:right;" | refresh_token
| (string):
The refresh token.
|-
| style="text-align:right;" | scope
| (string):
The scope of the token.
|-
| style="text-align:right;" | token_type
| (string):
The type of access token — always 'bearer'.
|}
|}
|-
| 400
| Error as specified by standard (username/password is wrong, for example)
|-
| colspan=2 |
{|
| <source>
{
"status": {
"code": 0,
"detail": {
},
"message": "string"
}
}
</source>
|
{| class="web-api-body-table"
| colspan=2 | <div class="web-api-body-obj"> ResponseStatus </div>
|-
| style="text-align:right;" | code
| (integer):
|-
| style="text-align:right;" | detail
| (object):
|-
| style="text-align:right;" | message
| (string):
|-
| colspan=2 | <div class="web-api-body-obj"> ErrorResponse </div>
|-
| style="text-align:right;" | status
| (ResponseStatus):
|}
|}
|-
| 401
| Unauthorized
|-
| colspan=2 |
{|
| <source>
{
"status": {
"code": 0,
"detail": {
},
"message": "string"
}
}
</source>
|
{| class="web-api-body-table"
| colspan=2 | <div class="web-api-body-obj"> ResponseStatus </div>
|-
| style="text-align:right;" | code
| (integer):
|-
| style="text-align:right;" | detail
| (object):
|-
| style="text-align:right;" | message
| (string):
|-
| colspan=2 | <div class="web-api-body-obj"> ErrorResponse </div>
|-
| style="text-align:right;" | status
| (ResponseStatus):
|}
|}
|-
| 403
| Forbidden
|-
| colspan=2 |
{|
| <source>
{
"status": {
"code": 0,
"detail": {
},
"message": "string"
}
}
</source>
|
{| class="web-api-body-table"
| colspan=2 | <div class="web-api-body-obj"> ResponseStatus </div>
|-
| style="text-align:right;" | code
| (integer):
|-
| style="text-align:right;" | detail
| (object):
|-
| style="text-align:right;" | message
| (string):
|-
| colspan=2 | <div class="web-api-body-obj"> ErrorResponse </div>
|-
| style="text-align:right;" | status
| (ResponseStatus):
|}
|}
|-
| 503
| Service unavailable
|}
<div class="web-api-section-heading">Usage</div>
<source lang="cURL">
curl -X POST
-H "x-api-key: your_API_key"
-H "Content-Type: application/json"

"https://api-demo.com/auth/v3/oauth/token?"
</source>
</div>
</div>


<div class="web-api-get mw-collapsible mw-collapsed">
{| class="web-api-introduction-table"
| style="width: 150px" | <div class="web-api-get-text"> GET </div>
| <div class="web-api-urlpath">/openid/userinfo</div>
<div class="web-api-summary">Get OpenID user information by access token</div>
|}
<div class="mw-collapsible-content">
<div class="web-api-description">Get information about a user by their OAuth 2 access token.</div>
<div class="web-api-section-heading">Parameters</div>
{| class="web-api-parameters-table"
! Name !! Default !! Description !! Parameter Type !! Data Type !! Required
|-
| Authorization
|
| The OAuth 2 bearer access token you received from <tt>/auth/v3/oauth/token</tt>. For example: <tt>Authorization: bearer a4b5da75-a584-4053-9227-0f0ab23ff06e</tt>
| header
| string
| true
|}
<div class="web-api-section-heading">Responses</div>
{| class="web-api-responses-table"
! Code !! Reason
|-
| 200
| Ok
|-
| colspan=2 |
{|
| <source>
{
"aud": "string",
"authorities": [
{
"name": "string",
"privileges": [

]
}
],
"contact_center_id": "string",
"dbid": 0,
"email": "string",
"environment_id": "string",
"family_name": "string",
"given_name": "string",
"properties": {
"<key>": ""
},
"sub": "string",
"user_name": "string"
}
</source>
|
{| class="web-api-body-table"
| colspan=2 | <div class="web-api-body-obj"> UserRole </div>
|-
| style="text-align:right;" | name
| (string):
|-
| style="text-align:right;" | privileges
| (array:string):
|-
| colspan=2 | <div class="web-api-body-obj"> OpenIdUserInfo </div>
|-
| style="text-align:right;" | aud
| (string):
OpenID Connect 'aud' claim. This is present if user authenticated with openid scope.
|-
| style="text-align:right;" | authorities
| (array:UserRole):
Authorities assigned to the user.
|-
| style="text-align:right;" | contact_center_id
| (string):
OpenID Connect 'aud' claim. This is present if user authenticated with openid scope.
|-
| style="text-align:right;" | dbid
| (integer):
The DBID of the corresponding user record in Configuration Server. This is present if the user belongs to a contact center.
|-
| style="text-align:right;" | email
| (string):
OpenID Connect 'email' claim. This is present if user authenticated with openid scope.
|-
| style="text-align:right;" | environment_id
| (string):
OpenID Connect 'environment_id' claim. This is present if user authenticated with openid scope.
|-
| style="text-align:right;" | family_name
| (string):
OpenID Connect 'family_name' (last name) claim. This is present if user authenticated with openid scope.
|-
| style="text-align:right;" | given_name
| (string):
OpenID Connect 'given_name' (first name) claim. This is present if user authenticated with openid scope.
|-
| style="text-align:right;" | properties
| (object):
The user's properties
|-
| style="text-align:right;" | sub
| (string):
OpenID Connect 'sub' claim. This is present if user authenticated with openid scope.
|-
| style="text-align:right;" | user_name
| (string):
OpenID Connect 'aud' claim. This is present if user authenticated with openid scope.
|}
|}
|-
| 401
| Unauthorized
|-
| 503
| Service unavailable
|}
<div class="web-api-section-heading">Usage</div>
<source lang="cURL">
curl -X GET
-H "x-api-key: your_API_key"
-H "Content-Type: application/json"

"https://api-demo.com/auth/v3/openid/userinfo?"
</source>
</div>
</div>


<div class="web-api-get mw-collapsible mw-collapsed">
{| class="web-api-introduction-table"
| style="width: 150px" | <div class="web-api-get-text"> GET </div>
| <div class="web-api-urlpath">/ping</div>
<div class="web-api-summary">Check connection</div>
|}
<div class="mw-collapsible-content">
<div class="web-api-description">Return 200 if user is authenticated otherwise 403.</div>
<div class="web-api-section-heading">Responses</div>
{| class="web-api-responses-table"
! Code !! Reason
|-
| 200
| Ok
|-
| colspan=2 |
{|
| <source>
{
"data": {
},
"errors": [
{
"status": {
"code": 0,
"detail": {
},
"message": "string"
}
}
],
"path": "string",
"status": {
"code": 0,
"detail": {
},
"message": "string"
}
}
</source>
|
{| class="web-api-body-table"
| colspan=2 | <div class="web-api-body-obj"> ResponseStatus </div>
|-
| style="text-align:right;" | code
| (integer):
|-
| style="text-align:right;" | detail
| (object):
|-
| style="text-align:right;" | message
| (string):
|-
| colspan=2 | <div class="web-api-body-obj"> ErrorResponse </div>
|-
| style="text-align:right;" | status
| (ResponseStatus):
|-
| colspan=2 | <div class="web-api-body-obj"> ApiResponse </div>
|-
| style="text-align:right;" | data
| (object):
|-
| style="text-align:right;" | errors
| (array:ErrorResponse):
|-
| style="text-align:right;" | path
| (string):
|-
| style="text-align:right;" | status
|(ResponseStatus):
|}
|}
|-
| 403
| Prohibited
|-
| 503
| Service unavailable
|}
<div class="web-api-section-heading">Usage</div>
<source lang="cURL">
curl -X GET
-H "x-api-key: your_API_key"
-H "Content-Type: application/json"

"https://api-demo.com/auth/v3/ping?"
</source>
</div>
</div>


<div class="web-api-get mw-collapsible mw-collapsed">
{| class="web-api-introduction-table"
| style="width: 150px" | <div class="web-api-get-text"> GET </div>
| <div class="web-api-urlpath">/sign-out</div>
<div class="web-api-summary">Sign-out a logged in user</div>
|}
<div class="mw-collapsible-content">
<div class="web-api-description">Sign-out the current user and invalidate either the current token or all tokens associated with the user.</div>
<div class="web-api-section-heading">Parameters</div>
{| class="web-api-parameters-table"
! Name !! Default !! Description !! Parameter Type !! Data Type !! Required
|-
| Authorization
|
| The OAuth 2 bearer access token you received from /auth/v3/oauth/token. For example: <tt>Authorization: bearer a4b5da75-a584-4053-9227-0f0ab23ff06e</tt>
| header
| string
| true
|-
| global
|
| Specifies whether to invalidate all tokens for the current user (<tt>true</tt>) or only the current token (<tt>false</tt>).
| query
| boolean
|
|-
| redirectUri
|
| Specifies the URI where the browser is redirected after sign-out is successful.
| query
| string
|
|}
<div class="web-api-section-heading">Responses</div>
{| class="web-api-responses-table"
! Code !! Reason
|-
| 200
| Ok
|-
| colspan=2 |
{|
| <source>
{
"data": {
},
"errors": [
{
"status": {
"code": 0,
"detail": {
},
"message": "string"
}
}
],
"path": "string",
"status": {
"code": 0,
"detail": {
},
"message": "string"
}
}
</source>
|
{| class="web-api-body-table"
| colspan=2 | <div class="web-api-body-obj"> ResponseStatus </div>
|-
| style="text-align:right;" | code
| (integer):
|-
| style="text-align:right;" | detail
| (object):
|-
| style="text-align:right;" | message
| (string):
|-
| colspan=2 | <div class="web-api-body-obj"> ErrorResponse </div>
|-
| style="text-align:right;" | status
| (ResponseStatus):
|-
| colspan=2 | <div class="web-api-body-obj"> ApiResponse </div>
|-
| style="text-align:right;" | data
| (object):
|-
| style="text-align:right;" | errors
| (array:ErrorResponse):
|-
| style="text-align:right;" | path
| (string):
|-
| style="text-align:right;" | status
| (ResponseStatus):
|}
|}
|-
| 401
| Unauthorized
|-
| 503
| Service unavailable
|}
<div class="web-api-section-heading">Usage</div>
<source lang="cURL">
curl -X GET
-H "x-api-key: your_API_key"
-H "Content-Type: application/json"

"https://api-demo.com/auth/v3/sign-out?global=true&redirectUri=string"
</source>
</div>
</div>


<div class="web-api-post mw-collapsible mw-collapsed">
{| class="web-api-introduction-table"
| style="width: 150px" | <div class="web-api-post-text"> POST </div>
| <div class="web-api-urlpath">/sign-out</div>
<div class="web-api-summary">Sign-out a logged in user</div>
|}
<div class="mw-collapsible-content">
<div class="web-api-description">Sign-out the current user and invalidate either the current token or all tokens associated with the user.</div>
<div class="web-api-section-heading">Parameters</div>
{| class="web-api-parameters-table"
! Name !! Default !! Description !! Parameter Type !! Data Type !! Required
|-
| Authorization
|
| The OAuth 2 bearer access token you received from <tt>/auth/v3/oauth/token</tt>. For example: <tt>Authorization: bearer a4b5da75-a584-4053-9227-0f0ab23ff06e</tt>
| header
| string
| true
|-
| global
|
| Specifies whether to invalidate all tokens for the current user (<tt>true</tt>) or only the current token (<tt>false</tt>).
| query
| boolean
|
|}
<div class="web-api-section-heading">Responses</div>
{| class="web-api-responses-table"
! Code !! Reason
|-
| 200
| Ok
|-
| colspan=2 |
{|
| <source>
{
"data": {
},
"errors": [
{
"status": {
"code": 0,
"detail": {
},
"message": "string"
}
}
],
"path": "string",
"status": {
"code": 0,
"detail": {
},
"message": "string"
}
}
</source>
|
{| class="web-api-body-table"
| colspan=2 | <div class="web-api-body-obj"> ResponseStatus </div>
|-
| style="text-align:right;" | code
| (integer):
|-
| style="text-align:right;" | detail
| (object):
|-
| style="text-align:right;" | message
| (string):
|-
| colspan=2 | <div class="web-api-body-obj"> ErrorResponse </div>
|-
| style="text-align:right;" | status
| (ResponseStatus):
|-
| colspan=2 | <div class="web-api-body-obj"> ApiResponse </div>
|-
| style="text-align:right;" | data
| (object):
|-
| style="text-align:right;" | errors
| (array:ErrorResponse):
|-
| style="text-align:right;" | path
| (string):
|-
| style="text-align:right;" | status
| (ResponseStatus):
|}
|}
|-
| 401
| Unauthorized
|-
| 503
| Service unavailable
|}
<div class="web-api-section-heading">Usage</div>
<source lang="cURL">
curl -X POST
-H "x-api-key: your_API_key"
-H "Content-Type: application/json"

"https://api-demo.com/auth/v3/sign-out?global=true"
</source>
</div>
</div>


<div class="web-api-get mw-collapsible mw-collapsed">
{| class="web-api-introduction-table"
| style="width: 150px" | <div class="web-api-get-text"> GET </div>
| <div class="web-api-urlpath">/userinfo</div>
<div class="web-api-summary">Get user information by access token</div>
|}
<div class="mw-collapsible-content">
<div class="web-api-description">Get information about a user by their OAuth 2 access token.</div>
<div class="web-api-section-heading">Parameters</div>
{| class="web-api-parameters-table"
! Name !! Default !! Description !! Parameter Type !! Data Type !! Required
|-
| Authorization
|
| The OAuth 2 bearer access token. For example: <tt>Authorization: bearer a4b5da75-a584-4053-9227-0f0ab23ff06e</tt>
| header
| string
| true
|}
<div class="web-api-section-heading">Responses</div>
{| class="web-api-responses-table"
! Code !! Reason
|-
| 200
| Ok
|-
| colspan=2 |
{|
| <source>
{
"authorities": [
{
"name": "string",
"privileges": [

]
}
],
"cmeUserName": "string",
"contactCenterId": "string",
"dbid": 0,
"environmentId": "string",
"loginName": "string",
"properties": {
"<key>": ""
},
"username": "string"
}
</source>
|
{| class="web-api-body-table"
| colspan=2 | <div class="web-api-body-obj"> UserRole </div>
|-
| style="text-align:right;" | name
| (string):
|-
| style="text-align:right;" | privileges
| (array:string):
|-
| colspan=2 | <div class="web-api-body-obj"> CloudUserDetails </div>
|-
| style="text-align:right;" | authorities
| (array:UserRole):
Authorities assigned to the user.
|-
| style="text-align:right;" | cmeUserName
| (string):
The username in Configuration Server. This property is not set for users who aren't in Configuration Server (for example, applications/services, cloud system admin and so on.)
|-
| style="text-align:right;" | contactCenterId
| (string):
The ID of the contact center the user belongs to (if any).
|-
| style="text-align:right;" | dbid
| (integer):
The DBID of the corresponding user record in Configuration Server. This is present if the user belongs to a contact center.
|-
| style="text-align:right;" | environmentId
| (string):
The ID of the Genesys environment the user belongs to (if any).
|-
| style="text-align:right;" | loginName
| (string):
The username in Configuration Server. This property is not set for users who aren't in Configuration Server (for example, applications/services, cloud system admin and so on.)
|-
| style="text-align:right;" | properties
| (object):
The user's properties
|-
| style="text-align:right;" | username
| (string):
The system-wide unique name of the user. For contact center users, this includes the userName in Configuration Server, the DBID in Configuration Server and the contact center ID. For non-Configuration Server users the username can have other formats.
|}
|}
|-
| 401
| Unauthorized
|-
| 503
| Service unavailable
|}
<div class="web-api-section-heading">Usage</div>
<source lang="cURL">
curl -X GET
-H "x-api-key: your_API_key"
-H "Content-Type: application/json"

"https://api-demo.com/auth/v3/userinfo?"
</source>
</div>
</div>