Skip to main content

Application v1.0

Manage Organization Applications

info

You are viewing REST API documentation. This documentation is auto-generated from a swagger specification which itself is generated from annotations in the source code of the project. It is possible that this documentation includes bugs and that code samples are incomplete or wrong.

Authentication

Applications Service

Applications Controller

Get all available visible applications.

GET https://auvious.video:443/security/applications HTTP/1.1
Host: auvious.video:443
Accept: application/json

Parameters

ParameterInTypeRequiredDescription
offsetqueryinteger(int64)falsenone
pageNumberqueryinteger(int32)falsenone
pageSizequeryinteger(int32)falsenone
pagedquerybooleanfalsenone
sort.sortedquerybooleanfalsenone
sort.unsortedquerybooleanfalsenone
unpagedquerybooleanfalsenone

Responses

Overview
StatusMeaningDescriptionSchema
200OKOKInline
401UnauthorizedUnauthorizedNone
403ForbiddenForbiddenNone
404Not FoundNot FoundNone
Response Schema

Status Code 200

NameTypeRequiredRestrictionsDescription
anonymous[Application]falsenonenone
» ApplicationApplicationfalsenonenone
»» configobjectfalsenonenone
»» createdAtstring(date-time)falsenonenone
»» expiresAtstring(date-time)falsenonenone
»» idstringfalsenonenone
»» organizationIdstringfalsenonenone
»» typestringfalsenonenone
»» versioninteger(int64)falsenonenone
»» visiblebooleanfalsenonenone
Enumerated Values
PropertyValue
typeGENESYS
typeSETUP_TEST
typeSTANDALONE_OPENID
typeTALKDESK_OPENID
typeTEST
Examples

200 Response

[
{
"config": {},
"createdAt": "2019-08-24T14:15:22Z",
"expiresAt": "2019-08-24T14:15:22Z",
"id": "string",
"organizationId": "string",
"type": "GENESYS",
"version": 0,
"visible": true
}
]
caution

To perform this operation, you must be authenticated by means of one of the following methods: Client Credentials Flow ( Scopes: global ), Jwt ( Scopes: global ), None ( Scopes: global ), None ( Scopes: global ), None ( Scopes: global )

Code samples

curl -X GET https://auvious.video:443/security/applications \
-H 'Accept: application/json' \ -H 'Authorization: Bearer {access-token}'

Create an application

POST https://auvious.video:443/security/applications HTTP/1.1
Host: auvious.video:443
Content-Type: application/json
Accept: application/json

Use this operation to create a new application. For GENESYS type applications you should include at least your 'organizationId' and 'pcEnvironment' entries in the 'config' otherwise creation will be denied. It is also recommended to include 'integrationId' entry. Again for GENESYS type applications, this operation will check that the user has integrations:integration:add permission. Once more, for GENESYS type apps, you should include your parameters in three main entries: serviceParameters, agentParameters and customerParameters. You can include other parameters, but they will be visible to all members of the same organization as well as internal auvious services. Internal Services can create any application.

Request body

{
"config": {},
"id": "string",
"organizationId": "string",
"type": "GENESYS"
}

Parameters

ParameterInTypeRequiredDescription
bodybodyCreateApplicationWebCommandfalsenone

Responses

Overview
StatusMeaningDescriptionSchema
200OKOKCreateApplicationResponseValue
201CreatedCreatedNone
401UnauthorizedUnauthorizedNone
403ForbiddenForbiddenNone
404Not FoundNot FoundNone
Examples

200 Response

{
"id": "string"
}
caution

To perform this operation, you must be authenticated by means of one of the following methods: Client Credentials Flow ( Scopes: global ), Jwt ( Scopes: global ), None ( Scopes: global ), None ( Scopes: global ), None ( Scopes: global )

Code samples

curl -X POST https://auvious.video:443/security/applications \
-H 'Content-Type: application/json' \ -H 'Accept: application/json' \ -H 'Authorization: Bearer {access-token}'

Delete an application.

DELETE https://auvious.video:443/security/applications/{applicationId} HTTP/1.1
Host: auvious.video:443

Use this if you want to delete an application. If the app is GENESYS type, the user must have the permission integrations:integration:delete permission, otherwise this call will fail.

Parameters

ParameterInTypeRequiredDescription
applicationIdpathstringtrueapplicationId

Responses

Overview
StatusMeaningDescriptionSchema
204No ContentNo ContentNone
401UnauthorizedUnauthorizedNone
403ForbiddenForbiddenNone
caution

To perform this operation, you must be authenticated by means of one of the following methods: Client Credentials Flow ( Scopes: global ), Jwt ( Scopes: global ), None ( Scopes: global ), None ( Scopes: global ), None ( Scopes: global )

Code samples

curl -X DELETE https://auvious.video:443/security/applications/{applicationId} \
-H 'Authorization: Bearer {access-token}'

Read Application.

GET https://auvious.video:443/security/applications/{id} HTTP/1.1
Host: auvious.video:443
Accept: application/json

Use this operation to get configuration. For type GENESYS apps, if you are an integration admin user you will have 'integrations:integration:view' permission which is what this method will check in order to return all configuration entries. Otherwise, if the user is a microservice it will get back only serviceParameters, if the user is a customer he will only get back customerParameters while if the user is a non-admin agent he will get only agentParameters back

Parameters

ParameterInTypeRequiredDescription
idpathstringtrueid

Responses

Overview
StatusMeaningDescriptionSchema
200OKOKApplication
401UnauthorizedUnauthorizedNone
403ForbiddenForbiddenNone
404Not FoundNot FoundNone
Examples

200 Response

{
"config": {},
"createdAt": "2019-08-24T14:15:22Z",
"expiresAt": "2019-08-24T14:15:22Z",
"id": "string",
"organizationId": "string",
"type": "GENESYS",
"version": 0,
"visible": true
}
caution

To perform this operation, you must be authenticated by means of one of the following methods: Client Credentials Flow ( Scopes: global ), Jwt ( Scopes: global ), None ( Scopes: global ), None ( Scopes: global ), None ( Scopes: global )

Code samples

curl -X GET https://auvious.video:443/security/applications/{id} \
-H 'Accept: application/json' \ -H 'Authorization: Bearer {access-token}'

Update an application

PUT https://auvious.video:443/security/applications/{id} HTTP/1.1
Host: auvious.video:443
Content-Type: application/json

Use this operation to update an existing application. For GENESYS type applications you should include your organizationId and pcEnvironment values. This operation will be denied if the user doesn't have the 'integrations:integration:edit' permission.

Request body

{
"config": {},
"organizationId": "string",
"type": "GENESYS"
}

Parameters

ParameterInTypeRequiredDescription
idpathstringtrueid
bodybodyUpdateApplicationWebCommandfalsenone

Responses

Overview
StatusMeaningDescriptionSchema
201CreatedCreatedNone
204No ContentUpdatedNone
401UnauthorizedUnauthorizedNone
403ForbiddenForbiddenNone
404Not FoundNot FoundNone
caution

To perform this operation, you must be authenticated by means of one of the following methods: Client Credentials Flow ( Scopes: global ), Jwt ( Scopes: global ), None ( Scopes: global ), None ( Scopes: global ), None ( Scopes: global )

Code samples

curl -X PUT https://auvious.video:443/security/applications/{id} \
-H 'Content-Type: application/json' \ -H 'Authorization: Bearer {access-token}'

Schemas

Application

{
"config": {},
"createdAt": "2019-08-24T14:15:22Z",
"expiresAt": "2019-08-24T14:15:22Z",
"id": "string",
"organizationId": "string",
"type": "GENESYS",
"version": 0,
"visible": true
}

Application

Properties

NameTypeRequiredRestrictionsDescription
configobjectfalsenonenone
createdAtstring(date-time)falsenonenone
expiresAtstring(date-time)falsenonenone
idstringfalsenonenone
organizationIdstringfalsenonenone
typestringfalsenonenone
versioninteger(int64)falsenonenone
visiblebooleanfalsenonenone
Enumerated Values
PropertyValue
typeGENESYS
typeSETUP_TEST
typeSTANDALONE_OPENID
typeTALKDESK_OPENID
typeTEST

CreateApplicationResponseValue

{
"id": "string"
}

CreateApplicationResponseValue

Properties

NameTypeRequiredRestrictionsDescription
idstringfalsenonenone

CreateApplicationWebCommand

{
"config": {},
"id": "string",
"organizationId": "string",
"type": "GENESYS"
}

CreateApplicationWebCommand

Properties

NameTypeRequiredRestrictionsDescription
configobjectfalsenoneThe application configuration object. For GENESYS apps, serviceParameters will be shown only to service accounts and admins, agentParameters will only be shown to agents and customerParameters will be shown only to customers
idstringfalsenoneonly for access from internal service
organizationIdstringfalsenoneonly for access from internal service
typestringtruenonenone
Enumerated Values
PropertyValue
typeGENESYS
typeSETUP_TEST
typeSTANDALONE_OPENID
typeTALKDESK_OPENID
typeTEST

UpdateApplicationWebCommand

{
"config": {},
"organizationId": "string",
"type": "GENESYS"
}

UpdateApplicationWebCommand

Properties

NameTypeRequiredRestrictionsDescription
configobjectfalsenoneThe application configuration object. For GENESYS apps, serviceParameters will be shown only to service accounts and admins, agentParameters will only be shown to agents and customerParameters will be shown only to customers
organizationIdstringfalsenoneonly for access from internal service
typestringtruenonenone
Enumerated Values
PropertyValue
typeGENESYS
typeSETUP_TEST
typeSTANDALONE_OPENID
typeTALKDESK_OPENID
typeTEST