Skip to main content

Client v1.0

Manage Organization Clients (client credentials)

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โ€‹

Clientsโ€‹

Clients Controller

List clients of user organizationโ€‹

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

Use this to retrieve all clients for your organization

Responsesโ€‹

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

Status Code 200

NameTypeRequiredRestrictionsDescription
anonymous[ClientResponseValue]falsenonenone
ยป ClientResponseValueClientResponseValuefalsenonenone
ยปยป clientIdstringfalsenonenone
ยปยป clientSecretstringfalsenonenone
ยปยป descriptionstringfalsenonenone
Examplesโ€‹

200 Response

[
{
"clientId": "string",
"clientSecret": "string",
"description": "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 GET https://dev.auvious.video:443/security/clients \
-H 'Accept: application/json' \ -H 'Authorization: Bearer {access-token}'

Create a clientโ€‹

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

Use this to create a new client

Request bodyโ€‹

{
"description": "string"
}

Parametersโ€‹

ParameterInTypeRequiredDescription
bodybodyCreateClientWebCommandfalsenone

Responsesโ€‹

Overviewโ€‹
StatusMeaningDescriptionSchema
200OKOKClientResponseValue
201CreatedCreatedNone
401UnauthorizedUnauthorizedNone
403ForbiddenForbiddenNone
404Not FoundNot FoundNone
Examplesโ€‹

200 Response

{
"clientId": "string",
"clientSecret": "string",
"description": "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://dev.auvious.video:443/security/clients \
-H 'Content-Type: application/json' \ -H 'Accept: application/json' \ -H 'Authorization: Bearer {access-token}'

Delete client of user organizationโ€‹

DELETE https://dev.auvious.video:443/security/clients/{clientId} HTTP/1.1
Host: dev.auvious.video:443

Use this to delete a client for your organization

Parametersโ€‹

ParameterInTypeRequiredDescription
clientIdpathstringtrueclientId

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://dev.auvious.video:443/security/clients/{clientId} \
-H 'Authorization: Bearer {access-token}'

Schemasโ€‹

ClientResponseValueโ€‹

{
"clientId": "string",
"clientSecret": "string",
"description": "string"
}

ClientResponseValue

Propertiesโ€‹

NameTypeRequiredRestrictionsDescription
clientIdstringfalsenonenone
clientSecretstringfalsenonenone
descriptionstringfalsenonenone

CreateClientWebCommandโ€‹

{
"description": "string"
}

CreateClientWebCommand

Propertiesโ€‹

NameTypeRequiredRestrictionsDescription
descriptionstringfalsenoneclient description text