NiCE Logout API
The Logout API from NiCE — 1 operation(s) for logout.
Work with this as data
Every API here is available over the APIs.io API and to AI agents over MCP.
MCP server
One button, every client — Claude, Cursor, VS Code and the rest.
https://apis.io/mcp
Tools for apis
7 MCP tools reach this
find_apisBrowse and filter every API in the catalog.get_api_artifactsOne API's artifacts, grouped by type.get_openapiThe primary OpenAPI for this API.find_similar_apisAPIs that look like this one.apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.resolveTurn a domain, URL or GitHub org into the provider it belongs to.find_cohortsEvery scored population of providers in the catalog.
Call it yourself
curl for this page
This API
curl "https://apis.io/api/v1/apis/nice:nice-logout-api"
All apis
curl "https://apis.io/api/v1/apis?limit=25"Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.
Get an API key
Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.
A second provider on the same verified email joins the account you already have.
OpenAPI Specification
openapi: 3.2.0
info:
title: Nice Logout API
version: v1
description: 'Operations tagged Logout across 2 of this provider''s published API definitions: nice-authentication-globalauthentication.json, nice-authentication-globalauthentication-openapi.yml. Each path carries the servers of the definition it was published in.'
tags:
- name: Logout
paths:
/auth/authorize/logout:
get:
tags:
- Logout
summary: Request a logout of the CXone identity provider
description: Request a logout of the CXone identity provider. The user may be prompted for what to do.
parameters:
- in: query
name: id_token_hint
schema:
type: string
format: jwt
description: 'ID Token previously issued by the authentication service passed as a hint about the user''s current session.
This can help idenify the user and identify the client application for verifying the post logout redirect URL.
'
- in: query
name: post_logout_redirect_uri
schema:
type: string
format: url
description: "URL that the client is requesting that the agent be redirected to after logout. It must be registered with\nthe client associated with the current session. The use of this parameter requires that the `id_token_hint` \nparameter be supplied.\n"
- in: query
name: state
schema:
type: string
description: 'Optional state that will be passed to the redirect URL.
'
- in: query
description: A choice list of locales for the UX.
name: ui_locales
style: form
explode: false
schema:
type: array
items:
type: string
example: en-US en es jp
responses:
'200':
description: This response is used to both verify that the user wants to log out of the platform and to confirm that the logout has occurred if no redirect has been requested. It can also be used to indicate any error situations where the redirect cannot be used.
content:
text/html:
schema:
type: string
examples:
finalize-yes:
summary: Verify that the user has been logged out
value: '<!DOCTYPE html> <html>
<body>
<p>You have been successfully logged out. You may close this window.</p>
</body>
</html>'
error:
summary: Indicate an error has occurred
value: '<!DOCTYPE html> <html>
<body>
<p>An error has occurred due to an invalid logout request. You are not logged out. You may close this window.</p>
</body>
</html>'
headers:
Set-Cookie:
description: On a logout, clear state for future authentications.
required: false
schema:
type: string
example: cxone_sso_state=; Expires=Thu, 01 Jan 1970 00:00:00 GMT; Path=/auth/authorize; Secure; HttpOnly; SameSite=Lax
'302':
description: Logged out with requested redirect. This response is only used if the user is logged out of the CXone platform (they answered yes when asked).
headers:
Set-Cookie:
description: On a logout, clear state for future authentications.
required: true
schema:
type: string
example: cxone_sso_state=; Expires=Thu, 01 Jan 1970 00:00:00 GMT; Path=/auth/authorize; Secure; HttpOnly; SameSite=Lax
Location:
description: The requested redirect location.
required: true
schema:
type: string
format: url
example: https://app.com/logoutComplete
operationId: getAuthAuthorizeLogout
x-operation-id-source: derived
post:
tags:
- Logout
summary: Request a logout of the CXone identity provider
description: Request a logout of the CXone identity provider. The user may be prompted what to do next. The effect this has on other applications is not defined, but the next authentication request will prompt for user information. This endpoint follows the specification for OpenID Connect RP-Initiatied Logout.
requestBody:
description: This form contains the values corresponding to to the flow being requested.
required: true
content:
application/x-www-form-urlencoded:
schema:
oneOf:
- $ref: '#/components/schemas/logoutRequest'
examples:
initial:
summary: Initial request for logout to start.
value: id_token_hint=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c&post_logout_redirect_uri=https%3A%2F%2Fapp.com%2FlogoutComplete
affirmative:
summary: Logout request completed.
value: id_token_hint=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c&post_logout_redirect_uri=https%3A%2F%2Fapp.com%2FlogoutComplete&yes=Yes
responses:
'200':
description: This response is used to both confirm that the logout has occurred if no redirect has been requested. It can also be used to indicate any error situations where the redirect cannot be used.
content:
text/html:
schema:
type: string
examples:
finalize-yes:
summary: Verify that the user has been logged out
value: '<!DOCTYPE html> <html>
<body>
<p>You have been successfully logged out. You may close this window.</p>
</body>
</html>'
error:
summary: Indicate an error has occurred
value: '<!DOCTYPE html> <html>
<body>
<p>An error has occurred due to an invalid logout request. You are not logged out. You may close this window.</p>
</body>
</html>'
headers:
Set-Cookie:
description: On a logout, clear state for future authentications.
required: false
schema:
type: string
example: cxone_sso_state=; Expires=Thu, 01 Jan 1970 00:00:00 GMT; Path=/auth/authorize; Secure; HttpOnly; SameSite=Lax
'302':
description: Logged out with requested redirect. This response is only used if the user is logged out of the CXone platform (they answered yes when asked).
headers:
Set-Cookie:
description: On a logout, clear state for future authentications.
required: true
schema:
type: string
example: cxone_sso_state=; Expires=Thu, 01 Jan 1970 00:00:00 GMT; Path=/auth/authorize; Secure; HttpOnly; SameSite=Lax
Location:
description: The requested redirect location.
required: true
schema:
type: string
format: url
example: https://app.com/logoutComplete
operationId: postAuthAuthorizeLogout
x-operation-id-source: derived
components:
schemas:
logoutRequest:
title: Logout Request
type: object
properties:
id_token_hint:
type: string
format: jwt
description: 'ID Token previously issued by the authentication service passed as a hint about the user''s current session.
This can help idenify the user and identify the client application for verifying the post logout redirect URL.
'
post_logout_redirect_uri:
type: string
format: url
description: "URL that the client is requesting that the agent be redirected to after logout. It must be registered with\nthe client associated with the current session. The use of this parameter requires that the `id_token_hint` \nparameter be supplied.\n"
state:
type: string
description: 'Optional state that will be passed to the redirect URL.
'
ui_locales:
description: A choice list of locales for the UX.
type: array
items:
type: string
example: en-US en es jp
'yes':
type: string
description: 'The user''s response about logging out when a logout should occur.
'
'no':
type: string
description: 'The user''s response about logging out when no logout should occur.
'
securitySchemes:
tokenAuth:
type: http
scheme: basic
userAuth:
type: http
scheme: bearer
bearerFormat: JWT
x-refined-from:
- nice-authentication-globalauthentication.json
- nice-authentication-globalauthentication-openapi.yml