Skip to main content

Ticket v1.0

Manage Tickets which allow customers to safe api access

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

Tickets

Ticket Controller

Create a ticket

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

Create a new ticket. It defines what will be the username and to which conference the user will have access to. The ticket will be deleted once it's used once to obtain a token

Request body

{
"disabled": true,
"length": 0,
"organizationId": "string",
"properties": {},
"type": "GENESYS_MULTI_USE_TICKET"
}

Parameters

ParameterInTypeRequiredDescription
authenticatedquerybooleanfalsenone
authorities[0].authorityquerystringfalsenone
credentialsqueryobjectfalsenone
detailsqueryobjectfalsenone
principalqueryobjectfalsenone
bodybodyCreateTicketWebCommandfalsenone

Responses

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

200 Response

{
"createdAt": "2019-08-24T14:15:22Z",
"disabled": "2019-08-24T14:15:22Z",
"expired": true,
"expiresAt": "2019-08-24T14:15:22Z",
"id": "string",
"organizationId": "string",
"properties": {},
"revoked": "2019-08-24T14:15:22Z",
"type": "GENESYS_MULTI_USE_TICKET",
"userId": "string",
"version": 0
}
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/ticket \
-H 'Content-Type: application/json' \ -H 'Accept: application/json' \ -H 'Authorization: Bearer {access-token}'

Get a ticket.

GET https://auvious.video:443/security/ticket/{ticketId} HTTP/1.1
Host: auvious.video:443
Accept: */*

Get a ticket.

Parameters

ParameterInTypeRequiredDescription
ticketIdpathstringtrueticketId

Responses

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

200 Response

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/ticket/{ticketId} \
-H 'Accept: */*' \ -H 'Authorization: Bearer {access-token}'

Delete a ticket.

DELETE https://auvious.video:443/security/ticket/{ticketId} HTTP/1.1
Host: auvious.video:443

Delete a ticket. Optional operation, use it to delete a token early, before it's used or expired

Parameters

ParameterInTypeRequiredDescription
ticketIdpathstringtrueticketId

Responses

Overview
StatusMeaningDescriptionSchema
200OKOKNone
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/ticket/{ticketId} \
-H 'Authorization: Bearer {access-token}'

Disable a ticket

POST https://auvious.video:443/security/ticket/{ticketId}/disable HTTP/1.1
Host: auvious.video:443

Disable a ticket. If someone tries to use this ticket he will get 'error_description'='DISABLED'

Parameters

ParameterInTypeRequiredDescription
ticketIdpathstringtrueticketId

Responses

Overview
StatusMeaningDescriptionSchema
200OKOKNone
201CreatedCreatedNone
204No ContentNo ContentNone
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 POST https://auvious.video:443/security/ticket/{ticketId}/disable \
-H 'Authorization: Bearer {access-token}'

Enable a ticket

POST https://auvious.video:443/security/ticket/{ticketId}/enable HTTP/1.1
Host: auvious.video:443

Enable a ticket.

Parameters

ParameterInTypeRequiredDescription
ticketIdpathstringtrueticketId

Responses

Overview
StatusMeaningDescriptionSchema
200OKOKNone
201CreatedCreatedNone
204No ContentNo ContentNone
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 POST https://auvious.video:443/security/ticket/{ticketId}/enable \
-H 'Authorization: Bearer {access-token}'

Add to calendar

GET https://auvious.video:443/security/ticket/{ticketId}/event HTTP/1.1
Host: auvious.video:443
Accept: text/calendar
X-Forwarded-Proto: string
Host: string

Add to calendar

Parameters

ParameterInTypeRequiredDescription
ticketIdpathstringtrueticketId
calendarquerystringfalsecalendar
X-Forwarded-ProtoheaderstringfalseX-Forwarded-Proto
HostheaderstringtrueHost

Responses

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

200 Response

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/ticket/{ticketId}/event \
-H 'Accept: text/calendar' \ -H 'X-Forwarded-Proto: string' \ -H 'Host: string' \ -H 'Authorization: Bearer {access-token}'

Revoke a ticket

POST https://auvious.video:443/security/ticket/{ticketId}/revoke HTTP/1.1
Host: auvious.video:443

Revoke a ticket. If someone tries to use this ticket he will get 'error_description'='REVOKED'

Parameters

ParameterInTypeRequiredDescription
ticketIdpathstringtrueticketId

Responses

Overview
StatusMeaningDescriptionSchema
200OKOKNone
201CreatedCreatedNone
204No ContentNo ContentNone
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 POST https://auvious.video:443/security/ticket/{ticketId}/revoke \
-H 'Authorization: Bearer {access-token}'

Schemas

CreateTicketWebCommand

{
"disabled": true,
"length": 0,
"organizationId": "string",
"properties": {},
"type": "GENESYS_MULTI_USE_TICKET"
}

CreateTicketWebCommand

Properties

NameTypeRequiredRestrictionsDescription
disabledbooleanfalsenonenone
lengthinteger(int32)falsenonenone
organizationIdstringfalsenonenone
propertiesobjecttruenonenone
typestringtruenonenone
Enumerated Values
PropertyValue
typeGENESYS_MULTI_USE_TICKET
typeGENESYS_SCHEDULE_TICKET
typeGENESYS_SINGLE_USE_TICKET
typeMULTI_USE_TICKET
typeSCHEDULE_TICKET
typeSINGLE_USE_SCHEDULE_TICKET
typeSINGLE_USE_TICKET

Ticket

{
"createdAt": "2019-08-24T14:15:22Z",
"disabled": "2019-08-24T14:15:22Z",
"expired": true,
"expiresAt": "2019-08-24T14:15:22Z",
"id": "string",
"organizationId": "string",
"properties": {},
"revoked": "2019-08-24T14:15:22Z",
"type": "GENESYS_MULTI_USE_TICKET",
"userId": "string",
"version": 0
}

Ticket

Properties

NameTypeRequiredRestrictionsDescription
createdAtstring(date-time)falsenonenone
disabledstring(date-time)falsenonenone
expiredbooleanfalsenonenone
expiresAtstring(date-time)falsenonenone
idstringfalsenonenone
organizationIdstringfalsenonenone
propertiesobjectfalsenonenone
revokedstring(date-time)falsenonenone
typestringfalsenonenone
userIdstringfalsenonenone
versioninteger(int64)falsenonenone
Enumerated Values
PropertyValue
typeGENESYS_MULTI_USE_TICKET
typeGENESYS_SCHEDULE_TICKET
typeGENESYS_SINGLE_USE_TICKET
typeMULTI_USE_TICKET
typeSCHEDULE_TICKET
typeSINGLE_USE_SCHEDULE_TICKET
typeSINGLE_USE_TICKET