Add examples for adding a PlaybackGrant to an Access Token. (#944)

Author: sarahcstringer

rest/access-tokens/live-example/live-example.3.x.js

@@ -0,0 +1,36 @@
+const AccessToken = require('twilio').jwt.AccessToken;
+const PlaybackGrant = AccessToken.PlaybackGrant;
+
+// Used when generating any kind of tokens
+// To set up environmental variables, see http://twil.io/secure
+const twilioAccountSid = process.env.TWILIO_ACCOUNT_SID;
+const twilioApiKey = process.env.TWILIO_API_KEY;
+const twilioApiSecret = process.env.TWILIO_API_SECRET;
+
+// Create an access token which you will sign and return to the client,
+// containing the grant you will create in the next steps
+const token = new AccessToken(
+  twilioAccountSid,
+  twilioApiKey,
+  twilioApiSecret
+);
+
+// Create a PlaybackGrant resource for a specific PlayerStreamer
+// via the REST API
+const client = require('twilio')(twilioApiKey, twilioApiSecret, { 
+    accountSid: twilioAccountSid });
+client.media.playerStreamer('VJXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX')
+    .playbackGrant()
+    .create({ttl: 60})
+    .then(playbackGrant => {
+        // Wrap the PlaybackGrant that you received from the REST API
+        // in a PlaybackGrant object and then attach that wrapped
+        // grant to your Access Token
+        const wrappedPlaybackGrant = new PlaybackGrant({
+          grant: playbackGrant.grant
+        });
+        token.addGrant(wrappedPlaybackGrant);
+        // Serialize the token to a JWT string
+        console.log(token.toJwt());
+      }
+    );

rest/access-tokens/live-example/live-example.5.x.cs

@@ -0,0 +1,50 @@
+using System;
+using System.Collections.Generic;
+using Twilio;
+using Twilio.Rest.Api.V2010;
+using Twilio.Rest.Media.V1.PlayerStreamer;
+using Twilio.Jwt.AccessToken;
+using Newtonsoft.Json;
+
+
+class Example
+{
+    static void Main(string[] args)
+    {
+        // These values are necessary for any access token
+        // To set up environmental variables, see http://twil.io/secure
+        string twilioAccountSid = Environment.GetEnvironmentVariable("TWILIO_ACCOUNT_SID");
+        string twilioApiKey = Environment.GetEnvironmentVariable("TWILIO_API_KEY");
+        string twilioApiSecret = Environment.GetEnvironmentVariable("TWILIO_API_SECRET");
+
+        // Create a PlaybackGrant resource for a specific PlayerStreamer
+        // via the REST API. The pathSid value should be the PlayerStreamer SID.
+        TwilioClient.Init(twilioApiKey, twilioApiSecret, twilioAccountSid);
+        var playbackGrant = PlaybackGrantResource.Create(
+            ttl: 60,
+            pathSid: "VJ3f3dc19da15af020bb395f0487f5221d"
+        );
+
+        // Serialize the returned grant into <Dictionary<string, object>>
+        var json = JsonConvert.SerializeObject(playbackGrant.Grant);
+        var grantDictionary = JsonConvert.DeserializeObject<Dictionary<string, object>>(json);
+
+        // Wrap the grant you received from the API
+        // in a PlaybackGrant object and then attach that wrapped
+        // grant to your Access Token
+        var wrappedPlaybackGrant = new PlaybackGrant();
+        Console.WriteLine(playbackGrant);
+        wrappedPlaybackGrant.Grant = grantDictionary;
+
+        var grants = new HashSet<IGrant> { wrappedPlaybackGrant };
+
+        // Create an Access Token generator and attach the grants
+        var token = new Token(
+            twilioAccountSid,
+            twilioApiKey,
+            twilioApiSecret,
+            grants: grants);
+
+        Console.WriteLine(token.ToJwt());
+    }
+}

rest/access-tokens/live-example/live-example.5.x.php

@@ -0,0 +1,40 @@
+<?php
+// Get the PHP helper library from https://twilio.com/docs/libraries/php
+require_once '/path/to/vendor/autoload.php'; // Loads the library
+use Twilio\Jwt\AccessToken;
+use Twilio\Jwt\Grants\PlaybackGrant;
+use Twilio\Rest\Client;
+
+// Required for all Twilio access tokens
+// To set up environmental variables, see http://twil.io/secure
+$twilioAccountSid = getenv('TWILIO_ACCOUNT_SID');
+$twilioApiKey = getenv('TWILIO_API_KEY');
+$twilioApiSecret = getenv('TWILIO_API_KEY_SECRET');
+
+$twilio = new Client($twilioApiKey, $twilioApiSecret, $twilioAccountSid);
+
+// Create access token, which we will serialize and send to the client
+$token = new AccessToken(
+    $twilioAccountSid,
+    $twilioApiKey,
+    $twilioApiSecret,
+    3600
+);
+
+//Create a PlaybackGrant resource for a specific PlayerStreamer
+// via the REST API
+ $playbackGrant = $twilio->media->v1->playerStreamer("VJXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX")
+                                    ->playbackGrant()
+                                    ->create(["ttl" => 60]);
+
+// Wrap the grant you received from the API
+// in a PlaybackGrant object and then attach that wrapped
+// grant to your Access Token
+$wrappedPlaybackGrant = new PlaybackGrant();
+$wrappedPlaybackGrant->setGrant($playbackGrant->grant);
+
+// Add grant to token
+$token->addGrant($wrappedPlaybackGrant);
+
+// render token to string
+echo $token->toJWT();

rest/access-tokens/live-example/live-example.5.x.rb

@@ -0,0 +1,32 @@
+require 'twilio-ruby'
+
+# Required for any Twilio Access Token
+# To set up environmental variables, see http://twil.io/secure
+account_sid = ENV['TWILIO_ACCOUNT_SID']
+api_key = ENV['TWILIO_API_KEY']
+api_secret = ENV['TWILIO_API_KEY_SECRET']
+
+# Create a PlaybackGrant resource for a specific PlayerStreamer
+# via the REST API
+@client = Twilio::REST::Client.new(api_key, api_secret, account_sid)
+playback_grant = @client.media
+                        .player_streamer('VJXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX')
+                        .playback_grant
+                        .create(ttl: 60)
+
+# Wrap the grant you received from the API
+# in a PlaybackGrant object and then attach that wrapped
+# grant to your Access Token
+wrapped_playback_grant = Twilio::JWT::AccessToken::PlaybackGrant.new
+wrapped_playback_grant.grant = playback_grant.grant
+
+# Create an Access Token and attach the wrapped PlaybackGrant
+token = Twilio::JWT::AccessToken.new(
+  account_sid,
+  api_key,
+  api_secret,
+  [wrapped_playback_grant]
+)
+
+# Generate the token
+puts token.to_jwt

rest/access-tokens/live-example/live-example.7.x.py

@@ -0,0 +1,31 @@
+import os
+from twilio.jwt.access_token import AccessToken
+from twilio.jwt.access_token.grants import PlaybackGrant
+from twilio.rest import Client
+
+# Required for all Twilio Access Tokens
+# To set up environmental variables, see http://twil.io/secure
+account_sid = os.environ['TWILIO_ACCOUNT_SID']
+api_key = os.environ['TWILIO_API_KEY']
+api_secret = os.environ['TWILIO_API_KEY_SECRET']
+
+# Create Access Token with credentials
+token = AccessToken(account_sid, api_key, api_secret)
+
+# Create a PlaybackGrant resource for a specific PlayerStreamer
+# via the REST API
+client = Client(api_key, api_secret, account_sid)
+playback_grant = client.media \
+                    .player_streamer('VJXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX') \
+                    .playback_grant() \
+                    .create(ttl=60)
+
+
+# Wrap the grant you received from the API
+# in a PlaybackGrant object and then attach that wrapped
+# grant to your Access Token
+wrapped_grant = PlaybackGrant(grant=playback_grant.grant)
+token.add_grant(PlaybackGrant(grant=wrapped_grant))
+
+# Return token info as JSON
+print(token.to_jwt())

rest/access-tokens/live-example/live-example.8.x.java

@@ -0,0 +1,37 @@
+import com.twilio.Twilio;
+import com.twilio.jwt.accesstoken.AccessToken;
+import com.twilio.jwt.accesstoken.PlaybackGrant;
+
+public class TokenGenerator {
+
+  public static void main(String[] args) {
+    // Get your Account SID from https://twilio.com/console
+    // To set up environment variables, see http://twil.io/secure
+    // Required for all types of tokens
+    String twilioAccountSid = System.getenv("TWILIO_ACCOUNT_SID");
+    String twilioApiKey = System.getenv("TWILIO_API_KEY");
+    String twilioApiSecret = System.getenv("TWILIO_API_SECRET");
+
+    // Create a PlaybackGrant resource for a specific PlayerStreamer
+    // via the REST API
+    Twilio.init(twilioApiKey, twilioApiSecret, twilioAccountSid);
+    com.twilio.rest.media.v1.playerstreamer.PlaybackGrant playbackGrant =
+        com.twilio.rest.media.v1.playerstreamer.PlaybackGrant.creator("VJ3f3dc19da15af020bb395f0487f5221d")
+        .setTtl(60)
+        .create();
+
+    // Wrap the grant you received from the API
+    // in a PlaybackGrant object and then attach that wrapped
+    // grant to your Access Token
+    PlaybackGrant wrappedPlaybackGrant = new PlaybackGrant().setGrant(playbackGrant.getGrant());
+
+    // Create access token
+    AccessToken token = new AccessToken.Builder(
+      twilioAccountSid,
+      twilioApiKey,
+      twilioApiSecret
+    ).grant(wrappedPlaybackGrant).build();
+
+    System.out.println(token.toJwt());
+  }
+}

rest/access-tokens/live-example/meta.json

@@ -0,0 +1,4 @@
+{
+  "title": "Creating an Access Token (Twilio Live PlaybackGrant)",
+  "type": "server"
+}