Skip to main content

Twilio/iam

@keeb/twilio/iamv2026.08.25.2· 16d agoMODELS
01README

Twilio iam API models

02Release Notes
  • Updated: get_api_key, role_permission
03Models4
@keeb/twilio/iam/get-api-keyv2026.08.25.2get_api_key.ts

Global Arguments

ArgumentTypeDescription
account_sid?stringTwilio Account SID (starts with AC). Also substituted for {AccountSid} path parameters. Overrides the TWILIO_ACCOUNT_SID environment variable.
namestringInstance name for this resource (used as the unique identifier in the factory pattern)
friendly_name?stringA descriptive string that you create to describe the resource. It can be up to 64 characters long.
policystring
key_type?stringThe \\`KeyType\\` form parameter is used to specify the type of key you want to create. **Default Behavior**: If \\`KeyType\\` is not specified, the API will generate a standard key. **Restricted Key**: If \\`KeyType\\` is set to \\`restricted\\`, the API will create a new restricted key. In this case, a po
auth_token?stringTwilio auth token, used as the HTTP Basic password when no API key is set. Overrides TWILIO_AUTH_TOKEN. Wire with a vault.get(...) expression to source it from a vault.
api_key_sid?stringTwilio API key SID (starts with SK). Takes precedence over auth_token. Overrides TWILIO_API_KEY_SID.
api_key_secret?stringTwilio API key secret, paired with api_key_sid. Overrides TWILIO_API_KEY_SECRET. Wire with a vault.get(...) expression to source it from a vault.
fn create()
Create a get api key
fn get(id: string)
Get a get api key
ArgumentTypeDescription
idstringThe sid of the get api key
fn lookup(account_sid?: string, max_items?: number)
List get api keys and record each as a data artifact (capped at 200 by default; writes a get_api_key_lookup record with the coverage of the walk)
ArgumentTypeDescription
account_sid?stringThe SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the Payments resource.
max_items?numberStop after this many results (default 200, ceiling 1000000). Raise deliberately: Twilio's message and call logs are effectively endless, and every result becomes its own data artifact. When the walk stops here with rows still on offer, the get_api_key_lookup record reports truncated: true.
fn update()
Update get api key attributes
fn delete(id: string)
Delete the get api key
ArgumentTypeDescription
idstringThe sid of the get api key
fn sync()
Sync get api key state from Twilio

Resources

state(infinite)— Get api key resource state
get_api_key_lookup(infinite)— Get api key lookup coverage — whether the page walk exhausted the collection
@keeb/twilio/iam/o-auth-appv2026.08.25.1o_auth_app.ts

Global Arguments

ArgumentTypeDescription
account_sid?stringTwilio Account SID (starts with AC). Also substituted for {AccountSid} path parameters. Overrides the TWILIO_ACCOUNT_SID environment variable.
namestringInstance name for this resource (used as the unique identifier in the factory pattern)
type?string
friendly_name?string
description?string
policy?object
access_token_ttl?number
owner_sid?string
client_sid?string
token_endpoint_auth_method?enumDetermines how the client authenticates. Account OAuth apps on v1 only support 'client_secret_basic'. For PKCE (none), use the v2 API.
auth_token?stringTwilio auth token, used as the HTTP Basic password when no API key is set. Overrides TWILIO_AUTH_TOKEN. Wire with a vault.get(...) expression to source it from a vault.
api_key_sid?stringTwilio API key SID (starts with SK). Takes precedence over auth_token. Overrides TWILIO_API_KEY_SID.
api_key_secret?stringTwilio API key secret, paired with api_key_sid. Overrides TWILIO_API_KEY_SECRET. Wire with a vault.get(...) expression to source it from a vault.
fn create()
Create a o auth app
fn update()
Update o auth app attributes
fn delete(id: string)
Delete the o auth app
ArgumentTypeDescription
idstringThe sid of the o auth app

Resources

state(infinite)— O auth app resource state
@keeb/twilio/iam/role-permissionv2026.08.25.2role_permission.ts

Global Arguments

ArgumentTypeDescription
account_sid?stringTwilio Account SID (starts with AC). Also substituted for {AccountSid} path parameters. Overrides the TWILIO_ACCOUNT_SID environment variable.
role_sidstringPath scope for the role permission: role_sid
name?stringInstance name for this resource (used as the unique identifier in the factory pattern)
auth_token?stringTwilio auth token, used as the HTTP Basic password when no API key is set. Overrides TWILIO_AUTH_TOKEN. Wire with a vault.get(...) expression to source it from a vault.
api_key_sid?stringTwilio API key SID (starts with SK). Takes precedence over auth_token. Overrides TWILIO_API_KEY_SID.
api_key_secret?stringTwilio API key secret, paired with api_key_sid. Overrides TWILIO_API_KEY_SECRET. Wire with a vault.get(...) expression to source it from a vault.
fn lookup(max_items?: number)
List role permissions and record each as a data artifact (capped at 200 by default; writes a role_permission_lookup record with the coverage of the walk)
ArgumentTypeDescription
max_items?numberStop after this many results (default 200, ceiling 100000). Raise deliberately: Twilio's message and call logs are effectively endless, and every result becomes its own data artifact. When the walk stops here with rows still on offer, the role_permission_lookup record reports truncated: true.

Resources

state(infinite)— Role permission resource state
role_permission_lookup(infinite)— Role permission lookup coverage — whether the page walk exhausted the collection
@keeb/twilio/iam/tokenv2026.08.25.1token.ts

Global Arguments

ArgumentTypeDescription
account_sid?stringTwilio Account SID (starts with AC). Also substituted for {AccountSid} path parameters. Overrides the TWILIO_ACCOUNT_SID environment variable.
namestringInstance name for this resource (used as the unique identifier in the factory pattern)
grant_typestringGrant type is a credential representing resource owner's authorization which can be used by client to obtain access token.
client_idstringA 34 character string that uniquely identifies this OAuth App.
client_secret?stringThe credential for confidential OAuth App.
code?stringJWT token related to the authorization code grant type.
redirect_uri?stringThe redirect uri
audience?stringThe targeted audience uri
refresh_token?stringJWT token related to refresh access token.
scope?stringThe scope of token
auth_token?stringTwilio auth token, used as the HTTP Basic password when no API key is set. Overrides TWILIO_AUTH_TOKEN. Wire with a vault.get(...) expression to source it from a vault.
api_key_sid?stringTwilio API key SID (starts with SK). Takes precedence over auth_token. Overrides TWILIO_API_KEY_SID.
api_key_secret?stringTwilio API key secret, paired with api_key_sid. Overrides TWILIO_API_KEY_SECRET. Wire with a vault.get(...) expression to source it from a vault.
fn create()
Create a token

Resources

state(infinite)— Token resource state
04Stats
B
85 / 100
Downloads
0
Archive size
25.4 KB
  • Has README or module doc2/2earned
  • README has a code example1/1earned
  • README is substantive1/1earned
  • Most symbols documented1/1earned
  • No slow types (deprecated)1/1earned
  • Dependencies pass trust audit2/2earned
  • Has description1/1earned
  • Platform support declared (or universal)2/2earned
  • License declared1/1earned
  • Verified public repository0/2missing
05Platforms
06Labels