REST API: Authorized Connect Apps

The AuthorizedConnectApps list resource shows all of the Connect Apps that you have authorized for your account. Each Connect App corresponds to a subaccount within your Twilio account, which acts as that Connect App's sandbox. The instance resource shows you the permissions you have granted for a Connect App as well as information about the Connect App itself.

AuthorizedConnectApp Instance Resource

Resource URI

1/2010-04-01/Accounts/{AccountSid}/AuthorizedConnectApps/{ConnectAppSid}
2

Resource Properties

Property nameTypeRequiredDescriptionChild properties

accountSidSID<AC>

Optional

Not PII

The SID of the Account that created the AuthorizedConnectApp resource.

Pattern: ^AC[0-9a-fA-F]{32}$Min length: 34Max length: 34

connectAppCompanyNamestring

Optional

Not PII

The company name set for the Connect App.

connectAppDescriptionstring

Optional

Not PII

A detailed description of the Connect App.

connectAppFriendlyNamestring

Optional

Not PII

The name of the Connect App.

connectAppHomepageUrlstring<uri>

Optional

Not PII

The public URL for the Connect App.

connectAppSidSID<CN>

Optional

Not PII

The SID that we assigned to the Connect App.

Pattern: ^CN[0-9a-fA-F]{32}$Min length: 34Max length: 34

permissionsarray[enum<string>]

Optional

Not PII

The set of permissions that you authorized for the Connect App. Can be: get-all or post-all.

Possible values:

get-allpost-all

uristring

Optional

Not PII

The URI of the resource, relative to https://api.twilio.com.

HTTP GET

Example

Retrieve an Authorized Connect App

1// Download the helper library from https://www.twilio.com/docs/node/install
2const twilio = require("twilio"); // Or, for ESM: import twilio from "twilio";
3
4// Find your Account SID and Auth Token at twilio.com/console
5// and set the environment variables. See http://twil.io/secure
6const accountSid = process.env.TWILIO_ACCOUNT_SID;
7const authToken = process.env.TWILIO_AUTH_TOKEN;
8const client = twilio(accountSid, authToken);
9
10async function fetchAuthorizedConnectApp() {
11  const authorizedConnectApp = await client
12    .authorizedConnectApps("CN47260e643654388faabe8aaa18ea6756")
13    .fetch();
14
15  console.log(authorizedConnectApp.accountSid);
16}
17
18fetchAuthorizedConnectApp();

Response

Note: This shows the raw API response from Twilio. Responses from SDKs (Java, Python, etc.) may look a little different.

1{
2  "account_sid": "ACXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
3  "connect_app_company_name": "aaa",
4  "connect_app_description": "alksjdfl;ajseifj;alsijfl;ajself;jasjfjas;lejflj",
5  "connect_app_friendly_name": "aaa",
6  "connect_app_homepage_url": "http://www.google.com",
7  "connect_app_sid": "CN47260e643654388faabe8aaa18ea6756",
8  "permissions": [
9    "get-all"
10  ],
11  "uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/AuthorizedConnectApps/CNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa.json"
12}

HTTP POST

Not supported.

HTTP PUT

Not supported.

HTTP DELETE

Not supported.

AuthorizedConnectApps List Resource

Resource URI

1/2010-04-01/Accounts/{AccountSid}/AuthorizedConnectApps
2

HTTP GET

Returns a list of Connect App resource representations, each representing a Connect App you've authorized to access your account. The list includes paging information.

Example 1

Retrieve all Authorized Connect Apps

1// Download the helper library from https://www.twilio.com/docs/node/install
2const twilio = require("twilio"); // Or, for ESM: import twilio from "twilio";
3
4// Find your Account SID and Auth Token at twilio.com/console
5// and set the environment variables. See http://twil.io/secure
6const accountSid = process.env.TWILIO_ACCOUNT_SID;
7const authToken = process.env.TWILIO_AUTH_TOKEN;
8const client = twilio(accountSid, authToken);
9
10async function listAuthorizedConnectApp() {
11  const authorizedConnectApps = await client.authorizedConnectApps.list({
12    limit: 20,
13  });
14
15  authorizedConnectApps.forEach((a) => console.log(a.accountSid));
16}
17
18listAuthorizedConnectApp();

Response

Note: This shows the raw API response from Twilio. Responses from SDKs (Java, Python, etc.) may look a little different.

1{
2  "authorized_connect_apps": [
3    {
4      "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
5      "connect_app_company_name": "aaa",
6      "connect_app_description": "alksjdfl;ajseifj;alsijfl;ajself;jasjfjas;lejflj",
7      "connect_app_friendly_name": "aaa",
8      "connect_app_homepage_url": "http://www.google.com",
9      "connect_app_sid": "CNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
10      "permissions": [
11        "get-all"
12      ],
13      "uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/AuthorizedConnectApps/CNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa.json"
14    }
15  ],
16  "end": 0,
17  "first_page_uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/AuthorizedConnectApps.json?Page=0&PageSize=50",
18  "next_page_uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/AuthorizedConnectApps.json?Page=2&PageSize=50",
19  "page": 0,
20  "page_size": 50,
21  "previous_page_uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/AuthorizedConnectApps.json?Page=1&PageSize=50",
22  "start": 0,
23  "uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/AuthorizedConnectApps.json?Page=0&PageSize=50"
24}

HTTP POST

Not Supported.

HTTP PUT

Not Supported.

HTTP DELETE

Not Supported.