NiCE Applications API
The Applications API from NiCE — 4 operation(s) for applications.
The Applications API from NiCE — 4 operation(s) for applications.
Every API here is available over the APIs.io API and to AI agents over MCP.
One button, every client — Claude, Cursor, VS Code and the rest.
https://apis.io/mcp
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.curl "https://apis.io/api/v1/apis/nice:nice-applications-api"
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.
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: 3.2.0
info:
title: Nice Applications API
version: v1
description: 'Operations tagged Applications across 2 of this provider''s published API definitions: nice-authentication-integrations.json, nice-authentication-integrations-openapi.yml. Each path carries the servers of the definition it was published in.'
tags:
- name: Applications
paths:
/applications:
post:
x-cxone-audience: external-public
x-cxone-productCatalogPermissions:
- application:create
summary: Create a new application
tags:
- Applications
description: Create a new application and return the new application including its assigned identifier and other fields.
operationId: createApplication
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/CreateApplicationV1'
examples:
CreateSecretV1:
$ref: '#/components/examples/CreateApplicationV1Secret'
CreatePKCEV1:
$ref: '#/components/examples/CreateApplicationV1PKCE'
CreateBackend:
$ref: '#/components/examples/CreateApplicationV1Backend'
CreateExisting:
$ref: '#/components/examples/CreateApplicationV1Existing'
responses:
'201':
description: Application created successfully and returned.
content:
application/json:
schema:
$ref: '#/components/schemas/GetCreatedApplicationV1'
examples:
CreateResponseV1Secret:
$ref: '#/components/examples/GetApplicationV1Secret'
CreateResponseV1PKCE:
$ref: '#/components/examples/GetApplicationV1PKCE'
links:
GetApplicationByApplicationId:
operationId: viewApplication
parameters:
applicationId: $response.body#/id
description: 'The `id` value returned in the response can be used as the `applicationId` parameter in `GET /applications/{applicationId}`.
'
'400':
$ref: '#/components/responses/BadRequest'
'401':
$ref: '#/components/responses/Unauthorized'
'403':
$ref: '#/components/responses/Forbidden'
get:
x-cxone-audience: external-public
x-cxone-productCatalogPermissions:
- application:view
summary: Return all applications
tags:
- Applications
description: This API will return all registered applications.
operationId: listApplication
responses:
'200':
description: Success, applications returned.
content:
application/json:
schema:
$ref: '#/components/schemas/ListApplicationV1'
examples:
onepage:
$ref: '#/components/examples/ExampleListApplicationOneV1'
'400':
$ref: '#/components/responses/BadRequest'
'401':
$ref: '#/components/responses/Unauthorized'
'403':
$ref: '#/components/responses/Forbidden'
/applications/{applicationId}:
parameters:
- in: path
name: applicationId
schema:
$ref: '#/components/schemas/ID-PARAM'
required: true
description: The unique identifier of the application.
get:
x-cxone-audience: external-public
x-cxone-productCatalogPermissions:
- application:view
summary: Return a single application based on its identifier
tags:
- Applications
description: Return a single application based on its identifier.
operationId: viewApplication
responses:
'200':
description: Success, application returned successfully
content:
application/json:
schema:
$ref: '#/components/schemas/GetApplicationV1'
examples:
success:
$ref: '#/components/examples/GetApplicationV1'
'400':
$ref: '#/components/responses/BadRequest'
'401':
$ref: '#/components/responses/Unauthorized'
'403':
$ref: '#/components/responses/Forbidden'
'404':
$ref: '#/components/responses/NotFound'
patch:
x-cxone-audience: external-public
x-cxone-productCatalogPermissions:
- application:edit
summary: Edit an existing application
tags:
- Applications
description: 'Edit an existing application. Immutable fields may be present and will be ignored.
Note that the type of the application may not be modifed. Any attempt to do so will result in a failure.
The payload may contain a subset of fields, with the other fields left unchanged.'
operationId: patchApplication
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/PatchApplicationV1'
examples:
PatchSecretV1:
$ref: '#/components/examples/PatchApplicationV1Secret'
responses:
'200':
description: Success, application modified successfully
content:
application/json:
schema:
$ref: '#/components/schemas/GetApplicationV1'
examples:
success:
$ref: '#/components/examples/GetApplicationV1'
'400':
$ref: '#/components/responses/BadRequest'
'401':
$ref: '#/components/responses/Unauthorized'
'403':
$ref: '#/components/responses/Forbidden'
'404':
$ref: '#/components/responses/NotFound'
'409':
$ref: '#/components/responses/Conflict'
delete:
x-cxone-audience: external-public
x-cxone-productCatalogPermissions:
- application:delete
summary: Schedule the deletion of an existing application
tags:
- Applications
description: 'Deletion of an application can have a huge impact, immediately disabling the ability
of many users to authenticate. Because of the possible impact a staged deletion is provided.
This call will only start the process of deletion. This call will:
* Schedule the delete operation for 14 days in the future.
* Disable the application.
After 14 days the application will be deleted with no future action required. Until that
time the process can be cancelled by calling the enable endpoint.
This process ensures that an accidental deletion can be immediately reverted by a single
API call. The specific configuration of the application doesn''t need to be recreated,
and no changes to users or other references need be done to revert the change.'
operationId: deleteApplication
responses:
'202':
description: Success, application scheduled for deletion and application returned.
content:
application/json:
schema:
$ref: '#/components/schemas/GetApplicationV1'
examples:
success:
$ref: '#/components/examples/GetApplicationV1Deleted'
'401':
$ref: '#/components/responses/Unauthorized'
'403':
$ref: '#/components/responses/Forbidden'
'404':
$ref: '#/components/responses/NotFound'
/applications/{applicationId}-enable:
parameters:
- in: path
name: applicationId
schema:
$ref: '#/components/schemas/ID-PARAM'
required: true
description: The unique identifier of the application.
post:
x-cxone-audience: external-public
x-cxone-productCatalogPermissions:
- application:enable
summary: Enable an existing application
tags:
- Applications
description: 'Enable an existing application. This action will also cancel any pending delete
operation.'
operationId: enableApplication
responses:
'204':
description: Success, application enabled.
'401':
$ref: '#/components/responses/Unauthorized'
'403':
$ref: '#/components/responses/Forbidden'
'404':
$ref: '#/components/responses/NotFound'
/applications/{applicationId}-disable:
parameters:
- in: path
name: applicationId
schema:
$ref: '#/components/schemas/ID-PARAM'
required: true
description: The unique identifier of the application.
post:
x-cxone-audience: external-public
x-cxone-productCatalogPermissions:
- application:disable
summary: Disable an existing application
tags:
- Applications
description: Disable an existing application.
operationId: disableApplication
responses:
'204':
description: Success, application disabled.
'401':
$ref: '#/components/responses/Unauthorized'
'403':
$ref: '#/components/responses/Forbidden'
'404':
$ref: '#/components/responses/NotFound'
'409':
$ref: '#/components/responses/Conflict'
components:
schemas:
CreateApplicationV1Full:
type: object
required:
- name
- description
- contacts
- type
- tenancy
allOf:
- $ref: '#/components/schemas/NAME'
- $ref: '#/components/schemas/DESCRIPTION'
- $ref: '#/components/schemas/CONTACTS'
- $ref: '#/components/schemas/TYPE'
- $ref: '#/components/schemas/TENANCY'
- $ref: '#/components/schemas/REDIRECTS'
- $ref: '#/components/schemas/ORIGINS'
- $ref: '#/components/schemas/LOGOUTS'
- $ref: '#/components/schemas/AUTHMETHOD'
- $ref: '#/components/schemas/JWKSENDPOINT'
- $ref: '#/components/schemas/SCOPE'
LASTMODIFIEDBY:
type: object
properties:
lastModifiedBy:
type: string
format: uuid
description: A reference to the userId that last modified the application. This field is immutable through the APIs.
ListOfApplicationV1:
type: object
properties:
applications:
type: array
items:
$ref: '#/components/schemas/GetApplicationV1'
SCHEDULEDDELETIONTIME:
type: object
properties:
scheduledDeletionTime:
type:
- string
- 'null'
format: date-time
description: The date and time using ISO 8601 format in UTC when the application is scheduled to be deleted. This field is immutable through the APIs.
TENANCY:
type: object
properties:
tenancy:
type: string
enum:
- single
- all
GetApplicationV1:
allOf:
- $ref: '#/components/schemas/GetApplicationBaseV1'
NAME:
type: object
properties:
name:
type: string
minLength: 1
maxLength: 256
GetCreatedApplicationV1:
allOf:
- $ref: '#/components/schemas/GetApplicationBaseV1'
- $ref: '#/components/schemas/SECRET'
AUTHMETHOD:
type: object
properties:
authMethod:
type: string
enum:
- client_secret_post
- client_secret_basic
ISENABLED:
type: object
properties:
isEnabled:
type: boolean
description: Indicates whether the application is enabled or not. A disabled application cannot be used to authenticate a user. This field can only be modified through the enable and disable API calls and otherwise is immutable.
CreateApplicationV1Existing:
type: object
required:
- id
- secret
allOf:
- $ref: '#/components/schemas/ID'
- $ref: '#/components/schemas/SECRET'
ID-PARAM:
type: string
format: uuid
description: All applications are identified by a unique UUID in standard string format.
example: 11e9d2b7-a96c-f8d0-ab21-c85b76b87f57
TYPE:
type: object
properties:
type:
type: string
enum:
- confidential
- public
- backend
CREATEDBY:
type: object
properties:
createdBy:
type: string
format: uuid
description: A reference to the userId that created the application. This field is immutable through the APIs.
CreateApplicationV1:
type: object
oneOf:
- $ref: '#/components/schemas/CreateApplicationV1Full'
- $ref: '#/components/schemas/CreateApplicationV1Existing'
SCOPE:
type: object
properties:
scope:
type: string
LASTMODIFIEDTIME:
type: object
properties:
lastModifiedTime:
type: string
format: date-time
description: The date and time using ISO 8601 format in UTC when the application was last modified. This field is immutable through the APIs.
ERROR:
type: object
properties:
error:
type: string
errorDescription:
type: string
CREATEDTIME:
type: object
properties:
createdTime:
type: string
format: date-time
description: The date and time using ISO 8601 format in UTC when the application was created. This field is immutable through the APIs.
LOGOUTS:
type: object
properties:
logouts:
type: array
items:
type: string
format: url
minLength: 10
maxLength: 128
DESCRIPTION:
type: object
properties:
description:
type: string
minLength: 0
maxLength: 2048
LASTUSEDTIME:
type: object
properties:
lastModifiedTime:
type: string
format: date-time
description: The date and time using ISO 8601 format in UTC when the application was last used. This field is immutable through the APIs.
JWKSENDPOINT:
type: object
properties:
jwksEndpoint:
type: string
format: url
ID:
type: object
properties:
id:
type: string
format: uuid
description: All applications are identified by a unique UUID in standard string format. This field is immutable through the APIs. This becomes the OpenID Connect/OAuth2 *client_id*.
example: 11e9d2b7-a96c-f8d0-ab21-c85b76b87f57
PatchApplicationV1:
type: object
allOf:
- $ref: '#/components/schemas/PatchApplicationBaseV1'
ORIGINS:
type: object
properties:
origins:
type: array
items:
type: string
format: url
minLength: 10
maxLength: 128
CONTACTS:
type: object
properties:
contacts:
type: array
minItems: 1
items:
type: string
format: email
SECRET:
type: object
properties:
secret:
type: string
description: Contains the secret assigned to the application.
example: 11e9d2b7a96cf8d0ab21c85b76b87f57
PatchApplicationBaseV1:
allOf:
- $ref: '#/components/schemas/ID'
- $ref: '#/components/schemas/NAME'
- $ref: '#/components/schemas/DESCRIPTION'
- $ref: '#/components/schemas/CONTACTS'
- $ref: '#/components/schemas/TYPE'
- $ref: '#/components/schemas/TENANCY'
- $ref: '#/components/schemas/REDIRECTS'
- $ref: '#/components/schemas/ORIGINS'
- $ref: '#/components/schemas/LOGOUTS'
- $ref: '#/components/schemas/AUTHMETHOD'
- $ref: '#/components/schemas/JWKSENDPOINT'
- $ref: '#/components/schemas/SCOPE'
- $ref: '#/components/schemas/ISENABLED'
- $ref: '#/components/schemas/CREATEDBY'
- $ref: '#/components/schemas/CREATEDTIME'
- $ref: '#/components/schemas/LASTMODIFIEDBY'
- $ref: '#/components/schemas/LASTMODIFIEDTIME'
- $ref: '#/components/schemas/LASTUSEDTIME'
- $ref: '#/components/schemas/SCHEDULEDDELETIONTIME'
ListApplicationV1:
allOf:
- $ref: '#/components/schemas/ListOfApplicationV1'
GetApplicationBaseV1:
type: object
required:
- id
- name
- description
- contacts
- type
- isEnabled
- createdBy
- createdTime
- lastModifiedBy
- lastModifiedTime
allOf:
- $ref: '#/components/schemas/ID'
- $ref: '#/components/schemas/NAME'
- $ref: '#/components/schemas/DESCRIPTION'
- $ref: '#/components/schemas/CONTACTS'
- $ref: '#/components/schemas/TYPE'
- $ref: '#/components/schemas/TENANCY'
- $ref: '#/components/schemas/REDIRECTS'
- $ref: '#/components/schemas/ORIGINS'
- $ref: '#/components/schemas/LOGOUTS'
- $ref: '#/components/schemas/AUTHMETHOD'
- $ref: '#/components/schemas/JWKSENDPOINT'
- $ref: '#/components/schemas/SCOPE'
- $ref: '#/components/schemas/ISENABLED'
- $ref: '#/components/schemas/CREATEDBY'
- $ref: '#/components/schemas/CREATEDTIME'
- $ref: '#/components/schemas/LASTMODIFIEDBY'
- $ref: '#/components/schemas/LASTMODIFIEDTIME'
- $ref: '#/components/schemas/LASTUSEDTIME'
- $ref: '#/components/schemas/SCHEDULEDDELETIONTIME'
REDIRECTS:
type: object
properties:
redirects:
type: array
minItems: 0
maxItems: 20
items:
type: string
format: url
minLength: 10
maxLength: 512
examples:
GetApplicationV1Secret:
summary: Example of a confidential application create response.
value:
id: 11e9d2b7-a96c-f8d0-ab21-c85b76b87f57
name: My New Application
description: This is a description of what the application is used for.
contacts:
- application-owner@company.com
type: confidential
tenancy: all
redirects:
- https://company.com/oath_redirect
origins:
- https://company.com
logouts:
- https://company.com/logout
authMethod: client_secret_basic
secret: DYKOOAJYVYQEPUKDUA==
isEnabled: true
createdBy: 11e9d2b7-a96c-f8d0-ab21-c85b76b87f57
createdTime: 2019-09-09T04:09:47.482+0000
lastModifiedBy: 11e9d2b7-a96c-f8d0-ab21-c85b76b87f57
lastModifiedTime: 2019-09-09T04:09:47.482+0000
lastUsedTime: 2020-09-09T10:00:05.482+0000
GetApplicationV1Deleted:
summary: Example of a deleted application response.
value:
id: 11e9d2b7-a96c-f8d0-ab21-c85b76b87f57
name: My New Application
description: This is a description of what the application is used for.
contacts:
- application-owner@company.com
type: confidential
tenancy: all
redirects:
- https://company.com/oath_redirect
origins:
- https://company.com
logouts:
- https://company.com/logout
authMethod: client_secret_basic
isEnabled: true
createdBy: 11e9d2b7-a96c-f8d0-ab21-c85b76b87f57
createdTime: 2019-09-09T04:09:47.482+0000
lastModifiedBy: 11e9d2b7-a96c-f8d0-ab21-c85b76b87f57
lastModifiedTime: 2019-09-09T04:09:47.482+0000
lastUsedTime: 2020-09-09T10:00:05.482+0000
scheduledDeletionTime: 2020-09-23T04:09:47.482+0000
GetApplicationV1:
summary: Example of an application value.
value:
id: 11e9d2b7-a96c-f8d0-ab21-c85b76b87f57
name: My New Application
description: This is a description of what the application is used for.
contacts:
- application-owner@company.com
type: confidential
tenancy: all
redirects:
- https://company.com/oath_redirect
origins:
- https://company.com
logouts:
- https://company.com/logout
authMethod: client_secret_basic
isEnabled: true
createdBy: 11e9d2b7-a96c-f8d0-ab21-c85b76b87f57
createdTime: 2019-09-09T04:09:47.482+0000
lastModifiedBy: 11e9d2b7-a96c-f8d0-ab21-c85b76b87f57
lastModifiedTime: 2019-09-09T04:09:47.482+0000
lastUsedTime: 2020-09-09T10:00:05.482+0000
CreateApplicationV1PKCE:
summary: Example of a create call for a public application (using PKCE).
value:
name: My Second New Application
description: This is a description of what the application is used for.
contacts:
- application-owner@company.com
type: public
tenancy: all
redirects:
- https://company.com/oath_redirect
origins:
- https://company.com
logouts:
- https://company.com/logout
CreateApplicationV1Existing:
summary: Example of a create call for an existing registration to assume ownership.
value:
id: 11e9d2b7-a96c-f8d0-ab21-c85b76b87f57
secret: ISJHYSDFF==
CreateApplicationV1Secret:
summary: Example of a create call for a confidential application (using a client secret).
value:
name: My New Application
description: This is a description of what the application is used for.
contacts:
- application-owner@company.com
type: confidential
tenancy: all
redirects:
- https://company.com/oath_redirect
origins:
- https://company.com
logouts:
- https://company.com/logout
authMethod: client_secret_basic
PatchApplicationV1Secret:
summary: Example of a patch.
value:
description: A new description.
CreateApplicationV1Backend:
summary: Example of a create call for a confidential back-end application (using a client secret).
value:
name: My New Application
description: This is a description of what the application is used for.
contacts:
- application-owner@company.com
type: back-end
tenancy: single
authMethod: client_secret_basic
GetApplicationV1PKCE:
summary: Example of a public application create response.
value:
id: 21e9d2b7-a96c-f8d0-ab21-c85b76b87f57
name: My Second New Application
description: This is a description of what the application is used for.
contacts:
- application-owner@company.com
type: public
tenancy: all
redirects:
- https://company.com/oath_redirect
origins:
- https://company.com
logouts:
- https://company.com/logouts
isEnabled: true
createdBy: 11e9d2b7-a96c-f8d0-ab21-c85b76b87f57
createdTime: 2019-09-09T04:09:47.482+0000
lastModifiedBy: 11e9d2b7-a96c-f8d0-ab21-c85b76b87f57
lastModifiedTime: 2019-09-09T04:09:47.482+0000
lastUsedTime: 2020-09-09T10:00:05.482+0000
ExampleListApplicationOneV1:
summary: Example response of a list with a single page ordered by name.
value:
applications:
- id: 11e9d2b7-a96c-f8d0-ab21-c85b76b87f57
name: My New Application
description: This is a description of what the application is used for.
contacts:
- application-owner@company.com
type: confidential
tenancy: all
redirects:
- https://company.com/oath_redirect
origins:
- https://company.com
logouts:
- https://company.com/logouts
authMethod: client_secret_basic
isEnabled: true
createdBy: 11e9d2b7-a96c-f8d0-ab21-c85b76b87f57
createdTime: 2019-09-09T04:09:47.482+0000
lastModifiedBy: 11e9d2b7-a96c-f8d0-ab21-c85b76b87f57
lastModifiedTime: 2019-09-09T04:09:47.482+0000
lastUsedTime: 2020-09-09T10:00:05.482+0000
- id: 21e9d2b7-a96c-f8d0-ab21-c85b76b87f57
name: My Second New Application
description: This is a description of what the application is used for.
contacts:
- application-owner@company.com
type: public
tenancy: all
redirects:
- https://company.com/oath_redirect
origins:
- https://company.com
logouts:
- https://company.com/logout
isEnabled: true
createdBy: 11e9d2b7-a96c-f8d0-ab21-c85b76b87f57
createdTime: 2019-09-09T04:09:47.482+0000
lastModifiedBy: 11e9d2b7-a96c-f8d0-ab21-c85b76b87f57
lastModifiedTime: 2019-09-09T04:09:47.482+0000
lastUsedTime: 2020-09-09T10:00:05.482+0000
responses:
Unauthorized:
description: The bearer token is improper, invalid, expired, etc.
content:
application/json:
schema:
$ref: '#/components/schemas/ERROR'
NotFound:
description: The application cannot be found.
content:
application/json:
schema:
$ref: '#/components/schemas/ERROR'
BadRequest:
description: The structure of the request was bad, meaning parameters were invalid or missing.
content:
application/json:
schema:
$ref: '#/components/schemas/ERROR'
Forbidden:
description: The user is not authorized to perform the action.
content:
application/json:
schema:
$ref: '#/components/schemas/ERROR'
Conflict:
description: 'The application is in a deleted state and so other operations are rejected. This
return will occur for any attempt to modify the application except for enable, which
cancels the delete operation.
'
x-refined-from:
- nice-authentication-integrations.json
- nice-authentication-integrations-openapi.yml