User access keys [VC 21.3 GEN] | Legacy 1 KB VidiNet

User access keys are long-lived tokens that can be used to authenticate a user. Access keys do not expire, compared to authentication tokens that do.

A user can have multiple access keys, and can be used to allow multiple services to use the API without having to share the user password. Individual access keys can also be disabled to revoke access.

Note that the secret will only be shown when a key is first created.

Managing access keys

List all access keys for a user

GET /user/(username)/key Retrieves the access keys for the specified user. Produces: application/xml, application/json – AccessKeyListDocument Role: _administrator

Example

GET /user/stephen/key
Accept: application/xml

<AccessKeyListDocument xmlns="http://xml.vidispine.com/schema/vidispine">
  <hits>1</hits>
  <key>
    <id>VSIDR62PJ4WSMJREGD6Z</id>
    <status>INACTIVE</status>
    <created>2018-06-01T10:31:17.275+02:00</created>
  </key>
</AccessKeyListDocument>

Create an access key

POST /user/(username)/key Generates a new access key and secret for the specified user. The only time the access key secret will be available is in the response of this request. Query Parameters: name (string) – A friendly name/description of the key. Produces: application/xml, application/json – AccessKeyDocument Role: _administrator

Example

POST /user/stephen/key/
Accept: application/xml

<AccessKeyDocument xmlns="http://xml.vidispine.com/schema/vidispine">
  <id>VSID2C56CQTA7DWW7DLF</id>
  <secret>PiFHewzGN3tZ/3lSeAkBVX+5YOw3wwpHTO2iqIaa</secret>
  <status>ACTIVE</status>
  <created>2018-06-01T10:36:13.891+02:00</created>
</AccessKeyDocument>

Retrieve an access key

GET /user/(username)/key/(key-id) Retrieves a specific access key. Produces: application/xml, application/json – AccessKeyDocument Role: _administrator

Example

GET /user/stephen/key/VSID2C56CQTA7DWW7DLF
Accept: application/xml

<AccessKeyDocument xmlns="http://xml.vidispine.com/schema/vidispine">
  <id>VSID2C56CQTA7DWW7DLF</id>
  <status>ACTIVE</status>
  <created>2018-06-01T10:36:13.891+02:00</created>
</AccessKeyDocument>

Update an access key

PUT /user/(username)/key/(key-id) Updates the name and/or status of a specific access key. Accepts: application/xml, application/json – AccessKeyDocument Produces: application/xml, application/json – AccessKeyDocument Role: _administrator

Example

PUT /user/stephen/key/VSID2C56CQTA7DWW7DLF
Content-Type: application/xml

<AccessKeyDocument xmlns="http://xml.vidispine.com/schema/vidispine">
  <status>INACTIVE</status>
  <name>Public status dashboard</name>
</AccessKeyDocument>

<AccessKeyDocument xmlns="http://xml.vidispine.com/schema/vidispine">
  <id>VSID2C56CQTA7DWW7DLF</id>
  <name>Public status dashboard</name>
  <status>INACTIVE</status>
  <created>2018-06-01T10:36:13.891+02:00</created>
</AccessKeyDocument>

Delete an access key

DELETE /user/(username)/key/(key-id) Removes the specific access key. Role: _administrator

Example

DELETE /user/stephen/key/VSID2C56CQTA7DWW7DLF

200 OK