Generate - Restricted Viewer Access Token

Service:

Azure Video Indexer

API Version:

2024-01-01

Generate an Azure Video Indexer restricted viewer access token.

POST https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.VideoIndexer/accounts/{accountName}/generateRestrictedViewerAccessToken?api-version=2024-01-01

URI Parameters

Name	In	Required	Type	Description
accountName	path	True	string minLength: 3 maxLength: 50 pattern: ^[A-Za-z0-9-]+$	The name of the Azure Video Indexer account.
resourceGroupName	path	True	string minLength: 1 maxLength: 90	The name of the resource group. The name is case insensitive.
subscriptionId	path	True	string minLength: 1	The ID of the target subscription.
api-version	query	True	string minLength: 1	The API version to use for this operation.

Request Body

Name	Required	Type	Description
scope	True	scope	The requested media type
projectId		string	The project ID
videoId		string	The video ID

Responses

Name	Type	Description
200 OK	AccessToken	The Azure Video Indexer account's access token properties were retrieved successfully.
Other Status Codes	ErrorResponse	Error response describing why the operation failed.

Security

azure_auth

Azure Active Directory OAuth2 Flow

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Name	Description
user_impersonation	impersonate your user account

Examples

Generate restricted viewer accessToken for account

Generate restricted viewer accessToken for project

Generate restricted viewer accessToken for video

Generate restricted viewer accessToken for account

Sample request

HTTP

POST https://management.azure.com/subscriptions/b04775c3-63fa-40f3-9430-139d2e5522d3/resourceGroups/contosto-azurevideoindexer-rg/providers/Microsoft.VideoIndexer/accounts/contosto-azurevideoindexer/generateRestrictedViewerAccessToken?api-version=2024-01-01

{
  "scope": "Account"
}

Sample response

Status code:

200

{
  "accessToken": "<jwt token of 1260 characters length>"
}

Generate restricted viewer accessToken for project

Sample request

HTTP

POST https://management.azure.com/subscriptions/b04775c3-63fa-40f3-9430-139d2e5522d3/resourceGroups/contosto-azurevideoindexer-rg/providers/Microsoft.VideoIndexer/accounts/contosto-azurevideoindexer/generateRestrictedViewerAccessToken?api-version=2024-01-01

{
  "scope": "Project",
  "projectId": "07ec9e38d4"
}

Sample response

Status code:

200

{
  "accessToken": "<jwt token of 1260 characters length>"
}

Generate restricted viewer accessToken for video

Sample request

HTTP

POST https://management.azure.com/subscriptions/b04775c3-63fa-40f3-9430-139d2e5522d3/resourceGroups/contosto-azurevideoindexer-rg/providers/Microsoft.VideoIndexer/accounts/contosto-azurevideoindexer/generateRestrictedViewerAccessToken?api-version=2024-01-01

{
  "scope": "Video",
  "videoId": "07ec9e38d4"
}

Sample response

Status code:

200

{
  "accessToken": "<jwt token of 1260 characters length>"
}

Definitions

Name	Description
AccessToken	Azure Video Indexer access token.
ErrorDefinition	Error definition.
ErrorResponse	Error response.
GenerateRestrictedViewerAccessTokenParameters	Restricted viewer access token generation request's parameters
scope	The requested media type

AccessToken

Object

Azure Video Indexer access token.

Name	Type	Description
accessToken	string	The access token.

ErrorDefinition

Object

Error definition.

Name	Type	Description
code	string	Service specific error code which serves as the substatus for the HTTP error code.
details	ErrorDefinition[]	Internal error details.
message	string	Description of the error.

ErrorResponse

Object

Error response.

Name	Type	Description
error	ErrorDefinition	The error details.

GenerateRestrictedViewerAccessTokenParameters

Object

Restricted viewer access token generation request's parameters

Name	Type	Description
projectId	string	The project ID
scope	scope	The requested media type
videoId	string	The video ID

scope

Enumeration

The requested media type

Value	Description
Video
Account
Project