Documentation

Auth tokens allow you to add additional layer of security to your videos. While we offer a way to do this through dashboard, bellow you will see how you can do that and even more through the API calls.

Fork me on GitHub
  • get
    Get a single auth token by token.
    ZiggeoSdk.Authtokens.get(token, [callbacks])
    
    This method returns JSON
  • update
    Update single auth token by token.
    ZiggeoSdk.Authtokens.update(token_or_key, arguments, [callbacks])
    
    1. volatile Will this object automatically be deleted if it remains empty?
    2. hidden If hidden, the token cannot be used directly.
    3. expiration_date Expiration date for the auth token (Unix epoch time format)
    4. usage_expiration_time Expiration time per session (seconds)
    5. session_limit Maximal number of sessions
    6. grants Permissions this tokens grants
    This method returns JSON
  • delete
    Delete a single auth token by token.
    ZiggeoSdk.Authtokens.destroy(token_or_key, [callbacks])
    
  • create
    Create a new auth token.
    ZiggeoSdk.Authtokens.create(arguments, [callbacks])
    
    1. volatile Will this object automatically be deleted if it remains empty?
    2. hidden If hidden, the token cannot be used directly.
    3. expiration_date Expiration date for the auth token (Unix epoch time format)
    4. usage_expiration_time Expiration time per session (seconds)
    5. session_limit Maximal number of sessions
    6. grants Permissions this tokens grants
    This method returns JSON
  • generate
    Creates the encrypted auth token object that you can pass to your recorder
    ZiggeoSdk.Auth.generate(arguments, [callbacks])
    
    1. volatile Will this object automatically be deleted if it remains empty?
    2. hidden If hidden, the token cannot be used directly.
    3. expiration_date Expiration date for the auth token (Unix epoch time format)
    4. usage_expiration_time Expiration time per session (seconds)
    5. session_limit Maximal number of sessions
    6. grants Permissions this tokens grants
    This method returns string