Skip to main content

Auvious Auth Server API v1.8.8-beta.0

Auvious Auth Server provides the core security related services.

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

Get a ticket.

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

Get a ticket.

Parameters

ParameterInTypeRequiredDescription
ticketIdpathstringtruenone

Responses

Overview
StatusMeaningDescriptionSchema
200OKOKTicket
Examples

200 Response

caution

To perform this operation, you must be authenticated by means of one of the following methods: BearerToken, OAuth2ClientCredentials

Code samples

curl -X GET http://auvious.video/security/ticket/{ticketId} \
-H 'Accept: */*' \ -H 'Authorization: Bearer {access-token}'

Update a ticket

PUT http://auvious.video/security/ticket/{ticketId} HTTP/1.1
Host: auvious.video
Content-Type: application/json
Accept: */*

Update a ticket with new properties. The ticket will be modified according to the provided properties.

Request body

{
"organizationId": "string",
"properties": {
"property1": {},
"property2": {}
}
}

Parameters

ParameterInTypeRequiredDescription
ticketIdpathstringtruenone
bodybodyUpdateTicketWebCommandtruenone

Responses

Overview
StatusMeaningDescriptionSchema
200OKOKTicket
Examples

200 Response

caution

To perform this operation, you must be authenticated by means of one of the following methods: BearerToken, OAuth2ClientCredentials

Code samples

curl -X PUT http://auvious.video/security/ticket/{ticketId} \
-H 'Content-Type: application/json' \ -H 'Accept: */*' \ -H 'Authorization: Bearer {access-token}'

Delete a ticket.

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

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

Parameters

ParameterInTypeRequiredDescription
ticketIdpathstringtruenone

Responses

Overview
StatusMeaningDescriptionSchema
200OKOKNone
caution

To perform this operation, you must be authenticated by means of one of the following methods: BearerToken, OAuth2ClientCredentials

Code samples

curl -X DELETE http://auvious.video/security/ticket/{ticketId} \
-H 'Authorization: Bearer {access-token}'

Create a ticket

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

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

{
"type": "GENESYS_SINGLE_USE_TICKET",
"organizationId": "string",
"properties": {
"property1": {},
"property2": {}
},
"length": 6,
"grouping": true,
"disabled": true,
"mode": "LETTERS_ONLY"
}

Parameters

ParameterInTypeRequiredDescription
bodybodyCreateTicketWebCommandtruenone

Responses

Overview
StatusMeaningDescriptionSchema
200OKOKTicket
Examples

200 Response

caution

To perform this operation, you must be authenticated by means of one of the following methods: BearerToken, OAuth2ClientCredentials

Code samples

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

Revoke a ticket

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

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

Parameters

ParameterInTypeRequiredDescription
ticketIdpathstringtruenone

Responses

Overview
StatusMeaningDescriptionSchema
204No ContentNo ContentNone
caution

To perform this operation, you must be authenticated by means of one of the following methods: BearerToken, OAuth2ClientCredentials

Code samples

curl -X POST http://auvious.video/security/ticket/{ticketId}/revoke \
-H 'Authorization: Bearer {access-token}'

Enable a ticket

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

Enable a ticket.

Parameters

ParameterInTypeRequiredDescription
ticketIdpathstringtruenone

Responses

Overview
StatusMeaningDescriptionSchema
204No ContentNo ContentNone
caution

To perform this operation, you must be authenticated by means of one of the following methods: BearerToken, OAuth2ClientCredentials

Code samples

curl -X POST http://auvious.video/security/ticket/{ticketId}/enable \
-H 'Authorization: Bearer {access-token}'

Disable a ticket

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

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

Parameters

ParameterInTypeRequiredDescription
ticketIdpathstringtruenone

Responses

Overview
StatusMeaningDescriptionSchema
204No ContentNo ContentNone
caution

To perform this operation, you must be authenticated by means of one of the following methods: BearerToken, OAuth2ClientCredentials

Code samples

curl -X POST http://auvious.video/security/ticket/{ticketId}/disable \
-H 'Authorization: Bearer {access-token}'

Add to calendar

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

Add to calendar

Parameters

ParameterInTypeRequiredDescription
ticketIdpathstringtruenone
calendarquerystringfalsenone
X-Forwarded-Protoheaderstringfalsenone
Hostheaderstringtruenone

Responses

Overview
StatusMeaningDescriptionSchema
200OKOKstring
Examples

200 Response

caution

To perform this operation, you must be authenticated by means of one of the following methods: BearerToken, OAuth2ClientCredentials

Code samples

curl -X GET http://auvious.video/security/ticket/{ticketId}/event \
-H 'Accept: text/calendar' \ -H 'X-Forwarded-Proto: https' \ -H 'Host: string' \ -H 'Authorization: Bearer {access-token}'

Schemas

UpdateTicketWebCommand

{
"organizationId": "string",
"properties": {
"property1": {},
"property2": {}
}
}

Properties

NameTypeRequiredRestrictionsDescription
organizationIdstringfalsenonenone
propertiesobjecttruenonenone
» additionalPropertiesobjectfalsenonenone

Ticket

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

Properties

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

CreateTicketWebCommand

{
"type": "GENESYS_SINGLE_USE_TICKET",
"organizationId": "string",
"properties": {
"property1": {},
"property2": {}
},
"length": 6,
"grouping": true,
"disabled": true,
"mode": "LETTERS_ONLY"
}

Properties

NameTypeRequiredRestrictionsDescription
typestringtruenonenone
organizationIdstringfalsenonenone
propertiesobjecttruenonenone
» additionalPropertiesobjectfalsenonenone
lengthinteger(int32)falsenonenone
groupingbooleanfalsenonenone
disabledbooleanfalsenonenone
modestringfalsenonenone
Enumerated Values
PropertyValue
typeGENESYS_SINGLE_USE_TICKET
typeGENESYS_MULTI_USE_TICKET
typeGENESYS_SCHEDULE_TICKET
typeMULTI_USE_TICKET
typeSCHEDULE_TICKET
typeAPPOINTMENTS_SCHEDULE_TICKET
typeSINGLE_USE_TICKET
typeSINGLE_USE_SCHEDULE_TICKET
typeSINGLE_USE_APPOINTMENTS_SCHEDULE_TICKET
modeLETTERS_ONLY
modeNUMBERS_ONLY
modeLETTERS_AND_NUMBERS