Generate a provider token
post
/content/management/api/v1.1/items/{id}/versions/{version}/providerTokens
for an asset at a specific version.
Request
Supported Media Types
- application/json
Path Parameters
-
id: string
id of the item.
-
version: string
The version of an item revision
Header Parameters
-
X-Requested-With: string
A custom header to mitigate CSRF attacks.Allowed Values:
[ "XMLHttpRequest" ]
Model class for generating provider token requests
Root Schema : ProviderToken
Type:
object
ProviderToken
Show Source
-
permissions(optional):
array permissions
permissions with which a token is to be generated; valid permissions are: view, download, contribute, and manage
-
provider:
object Provider
Provider
-
scope(optional):
object scope
Additional Properties Allowed: additionalPropertiesprovider specific properties to future identify a target for which a token is to be generated
-
token(optional):
string
Read Only:
true
generated token value
Nested Schema : permissions
Type:
array
permissions with which a token is to be generated; valid permissions are: view, download, contribute, and manage
Show Source
Nested Schema : scope
Type:
object
Additional Properties Allowed
Show Source
provider specific properties to future identify a target for which a token is to be generated
Nested Schema : additionalProperties
Type:
object
Response
Supported Media Types
- application/json
200 Response
OK.
Root Schema : ProviderToken
Type:
object
ProviderToken
Show Source
-
permissions(optional):
array permissions
permissions with which a token is to be generated; valid permissions are: view, download, contribute, and manage
-
provider:
object Provider
Provider
-
scope(optional):
object scope
Additional Properties Allowed: additionalPropertiesprovider specific properties to future identify a target for which a token is to be generated
-
token(optional):
string
Read Only:
true
generated token value
Nested Schema : permissions
Type:
array
permissions with which a token is to be generated; valid permissions are: view, download, contribute, and manage
Show Source
Nested Schema : scope
Type:
object
Additional Properties Allowed
Show Source
provider specific properties to future identify a target for which a token is to be generated
Nested Schema : additionalProperties
Type:
object
400 Response
Bad request.
403 Response
Forbidden.
404 Response
Not found.
500 Response
Internal server error.
Examples
The following example shows how to create a provider token for an asset at a specific version by submitting a POST request on the REST resource using cURL.
curl -X POST -H 'Content-Type: application/json' -H 'X-Requested-With: XMLHttpRequest' 'https://host:port/content/management/api/v1.1/items/{id}/versions/{version}/providerTokens'
Example 1:
This generates a kaltura provider preview token for the asset with id CONTB94719ABE603404BAE0D808C59989FF9 at version 1.1.
content/management/api/v1.1/items/CONTB94719ABE603404BAE0D808C59989FF9/versions/1.1/providerTokens
Request Payload
{ "provider": { "name": "kaltura" }, "permissions": [ "view" ] }
Request Headers
{ "Content-Type": "application/json", "X-Requested-With": "XMLHttpRequest" }
Response Body
{ "provider": { "name": "kaltura" }, "permissions": [ "view" ], "token": "djJ8MjY4ODY5MnzKkH1uN-6ud46e4G3RE67BkNdEkp2OBbrwsjXygj_nu7XJkTXB5DB1iE0XfJH1HWWe56SjbPo44GEqcu010rxAHldHtz5k_Q7aUQrYhbNDwQSAw-1OFpz90Cr8NUHUqLQsPKXYD3qBhv4ZsLCz0xQh" }
Example 2:
This generates a kaltura provider edit token for the asset with id CONTB94719ABE603404BAE0D808C59989FF9 at version 2.
/content/management/api/v1.1/items/CONTB94719ABE603404BAE0D808C59989FF9/versions/2/providerTokens
Request Payload
{ "provider": { "name": "kaltura" }, "permissions": [ "contribute" ] }
Request Headers
{ "Content-Type": "application/json", "X-Requested-With": "XMLHttpRequest" }
Response Body
{ "provider": { "name": "kaltura" }, "permissions": [ "contribute" ], "token": "djJ8MjY4ODY5MnzCABMfHMQeonjNtPn0_ZxOWoE7a7NqVxcDTpyoqMscJEr0btm83se9df310F9Ga2qkOGOmD-EkJHVBXwQ2Hp0JZPK_Ver9z9cPiw42kh_K93_ugMCwdbh94IKHax_VLZnEKy9jl5y4FMujsNOpbRPb" }