{ "openapi": "3.0.1", "security": [ { "oAuth2ClientCredentials": [] } ], "info": { "title": "Organization Public API", "contact": { "name": "Twilio Support", "url": "https://support.twilio.com", "email": "support@twilio.com" }, "license": { "name": "Apache 2.0", "url": "https://www.apache.org/licenses/LICENSE-2.0.html" }, "version": "1.0.0", "x-twilio": { "apiStandards": "v0.1" } }, "tags": [ { "name": "SCIM", "description": "SCIM 2.0 User endpoints" }, { "name": "OrganizationAccount", "description": "Organization Account operations" }, { "name": "RoleAssignments", "description": "Role assignment operations" }, { "name": "OauthV1Authorize" }, { "name": "OauthV1Token" } ], "paths": { "/Organizations/{OrganizationSid}/scim/ResourceTypes": { "servers": [ { "url": "https://preview-iam.twilio.com" } ] }, "/Organizations/{OrganizationSid}/scim/Users": { "servers": [ { "url": "https://preview-iam.twilio.com" } ], "get": { "tags": [ "SCIM" ], "summary": "List SCIM Users", "operationId": "ListOrganizationUsers", "parameters": [ { "name": "OrganizationSid", "in": "path", "required": true, "schema": { "pattern": "OR[0-9a-f]{32}", "type": "string", "format": "OrganizationSid", "example": "OR33f4f3aa6fffe840d000f8ef22e883db" } }, { "name": "filter", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of users", "content": { "application/scim+json": { "schema": { "$ref": "#/components/schemas/ScimUserPage" } } }, "headers": { "Access-Control-Allow-Origin": { "description": "Specify the origin(s) allowed to access the resource", "schema": { "type": "string" }, "example": "*" }, "Access-Control-Allow-Methods": { "description": "Specify the HTTP methods allowed when accessing the resource", "schema": { "type": "string" }, "example": "POST, OPTIONS" }, "Access-Control-Allow-Headers": { "description": "Specify the headers allowed when accessing the resource", "schema": { "type": "string" }, "example": "Content-Type, Authorization" }, "Access-Control-Allow-Credentials": { "description": "Indicates whether the browser should include credentials", "schema": { "type": "boolean" } }, "Access-Control-Expose-Headers": { "description": "Headers exposed to the client", "schema": { "type": "string", "example": "X-Custom-Header1, X-Custom-Header2" } } } }, "400": { "description": "Bad request or business rules violation", "content": { "application/scim+json": { "schema": { "$ref": "#/components/schemas/ScimError" } } }, "headers": { "Access-Control-Allow-Origin": { "description": "Specify the origin(s) allowed to access the resource", "schema": { "type": "string" }, "example": "*" }, "Access-Control-Allow-Methods": { "description": "Specify the HTTP methods allowed when accessing the resource", "schema": { "type": "string" }, "example": "POST, OPTIONS" }, "Access-Control-Allow-Headers": { "description": "Specify the headers allowed when accessing the resource", "schema": { "type": "string" }, "example": "Content-Type, Authorization" }, "Access-Control-Allow-Credentials": { "description": "Indicates whether the browser should include credentials", "schema": { "type": "boolean" } }, "Access-Control-Expose-Headers": { "description": "Headers exposed to the client", "schema": { "type": "string", "example": "X-Custom-Header1, X-Custom-Header2" } } } }, "401": { "description": "Unauthorized", "content": { "application/scim+json": { "schema": { "$ref": "#/components/schemas/ScimError" } } }, "headers": { "Access-Control-Allow-Origin": { "description": "Specify the origin(s) allowed to access the resource", "schema": { "type": "string" }, "example": "*" }, "Access-Control-Allow-Methods": { "description": "Specify the HTTP methods allowed when accessing the resource", "schema": { "type": "string" }, "example": "POST, OPTIONS" }, "Access-Control-Allow-Headers": { "description": "Specify the headers allowed when accessing the resource", "schema": { "type": "string" }, "example": "Content-Type, Authorization" }, "Access-Control-Allow-Credentials": { "description": "Indicates whether the browser should include credentials", "schema": { "type": "boolean" } }, "Access-Control-Expose-Headers": { "description": "Headers exposed to the client", "schema": { "type": "string", "example": "X-Custom-Header1, X-Custom-Header2" } } } }, "403": { "description": "Forbidden", "content": { "application/scim+json": { "schema": { "$ref": "#/components/schemas/ScimError" } } }, "headers": { "Access-Control-Allow-Origin": { "description": "Specify the origin(s) allowed to access the resource", "schema": { "type": "string" }, "example": "*" }, "Access-Control-Allow-Methods": { "description": "Specify the HTTP methods allowed when accessing the resource", "schema": { "type": "string" }, "example": "POST, OPTIONS" }, "Access-Control-Allow-Headers": { "description": "Specify the headers allowed when accessing the resource", "schema": { "type": "string" }, "example": "Content-Type, Authorization" }, "Access-Control-Allow-Credentials": { "description": "Indicates whether the browser should include credentials", "schema": { "type": "boolean" } }, "Access-Control-Expose-Headers": { "description": "Headers exposed to the client", "schema": { "type": "string", "example": "X-Custom-Header1, X-Custom-Header2" } } } }, "429": { "description": "Too many requests", "content": { "application/scim+json": { "schema": { "$ref": "#/components/schemas/ScimError" } } }, "headers": { "Access-Control-Allow-Origin": { "description": "Specify the origin(s) allowed to access the resource", "schema": { "type": "string" }, "example": "*" }, "Access-Control-Allow-Methods": { "description": "Specify the HTTP methods allowed when accessing the resource", "schema": { "type": "string" }, "example": "POST, OPTIONS" }, "Access-Control-Allow-Headers": { "description": "Specify the headers allowed when accessing the resource", "schema": { "type": "string" }, "example": "Content-Type, Authorization" }, "Access-Control-Allow-Credentials": { "description": "Indicates whether the browser should include credentials", "schema": { "type": "boolean" } }, "Access-Control-Expose-Headers": { "description": "Headers exposed to the client", "schema": { "type": "string", "example": "X-Custom-Header1, X-Custom-Header2" } } } } } }, "post": { "tags": [ "SCIM" ], "summary": "Create SCIM User", "operationId": "CreateOrganizationUser", "parameters": [ { "name": "OrganizationSid", "in": "path", "required": true, "schema": { "pattern": "OR[0-9a-f]{32}", "type": "string", "format": "OrganizationSid", "example": "ORceef74a747c1ae8d837aafb5a31e475f" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ScimUser" } }, "application/scim+json": { "schema": { "$ref": "#/components/schemas/ScimUser" } } }, "required": true }, "responses": { "201": { "description": "Created User", "content": { "application/scim+json": { "schema": { "$ref": "#/components/schemas/ScimUser" } } }, "headers": { "Access-Control-Allow-Origin": { "description": "Specify the origin(s) allowed to access the resource", "schema": { "type": "string" }, "example": "*" }, "Access-Control-Allow-Methods": { "description": "Specify the HTTP methods allowed when accessing the resource", "schema": { "type": "string" }, "example": "POST, OPTIONS" }, "Access-Control-Allow-Headers": { "description": "Specify the headers allowed when accessing the resource", "schema": { "type": "string" }, "example": "Content-Type, Authorization" }, "Access-Control-Allow-Credentials": { "description": "Indicates whether the browser should include credentials", "schema": { "type": "boolean" } }, "Access-Control-Expose-Headers": { "description": "Headers exposed to the client", "schema": { "type": "string", "example": "X-Custom-Header1, X-Custom-Header2" } } } }, "400": { "description": "Bad request or business rules violation", "content": { "application/scim+json": { "schema": { "$ref": "#/components/schemas/ScimError" } } }, "headers": { "Access-Control-Allow-Origin": { "description": "Specify the origin(s) allowed to access the resource", "schema": { "type": "string" }, "example": "*" }, "Access-Control-Allow-Methods": { "description": "Specify the HTTP methods allowed when accessing the resource", "schema": { "type": "string" }, "example": "POST, OPTIONS" }, "Access-Control-Allow-Headers": { "description": "Specify the headers allowed when accessing the resource", "schema": { "type": "string" }, "example": "Content-Type, Authorization" }, "Access-Control-Allow-Credentials": { "description": "Indicates whether the browser should include credentials", "schema": { "type": "boolean" } }, "Access-Control-Expose-Headers": { "description": "Headers exposed to the client", "schema": { "type": "string", "example": "X-Custom-Header1, X-Custom-Header2" } } } }, "401": { "description": "Unauthorized", "content": { "application/scim+json": { "schema": { "$ref": "#/components/schemas/ScimError" } } }, "headers": { "Access-Control-Allow-Origin": { "description": "Specify the origin(s) allowed to access the resource", "schema": { "type": "string" }, "example": "*" }, "Access-Control-Allow-Methods": { "description": "Specify the HTTP methods allowed when accessing the resource", "schema": { "type": "string" }, "example": "POST, OPTIONS" }, "Access-Control-Allow-Headers": { "description": "Specify the headers allowed when accessing the resource", "schema": { "type": "string" }, "example": "Content-Type, Authorization" }, "Access-Control-Allow-Credentials": { "description": "Indicates whether the browser should include credentials", "schema": { "type": "boolean" } }, "Access-Control-Expose-Headers": { "description": "Headers exposed to the client", "schema": { "type": "string", "example": "X-Custom-Header1, X-Custom-Header2" } } } }, "403": { "description": "Forbidden", "content": { "application/scim+json": { "schema": { "$ref": "#/components/schemas/ScimError" } } }, "headers": { "Access-Control-Allow-Origin": { "description": "Specify the origin(s) allowed to access the resource", "schema": { "type": "string" }, "example": "*" }, "Access-Control-Allow-Methods": { "description": "Specify the HTTP methods allowed when accessing the resource", "schema": { "type": "string" }, "example": "POST, OPTIONS" }, "Access-Control-Allow-Headers": { "description": "Specify the headers allowed when accessing the resource", "schema": { "type": "string" }, "example": "Content-Type, Authorization" }, "Access-Control-Allow-Credentials": { "description": "Indicates whether the browser should include credentials", "schema": { "type": "boolean" } }, "Access-Control-Expose-Headers": { "description": "Headers exposed to the client", "schema": { "type": "string", "example": "X-Custom-Header1, X-Custom-Header2" } } } }, "404": { "description": "Not found", "content": { "application/scim+json": { "schema": { "$ref": "#/components/schemas/ScimError" } } }, "headers": { "Access-Control-Allow-Origin": { "description": "Specify the origin(s) allowed to access the resource", "schema": { "type": "string" }, "example": "*" }, "Access-Control-Allow-Methods": { "description": "Specify the HTTP methods allowed when accessing the resource", "schema": { "type": "string" }, "example": "POST, OPTIONS" }, "Access-Control-Allow-Headers": { "description": "Specify the headers allowed when accessing the resource", "schema": { "type": "string" }, "example": "Content-Type, Authorization" }, "Access-Control-Allow-Credentials": { "description": "Indicates whether the browser should include credentials", "schema": { "type": "boolean" } }, "Access-Control-Expose-Headers": { "description": "Headers exposed to the client", "schema": { "type": "string", "example": "X-Custom-Header1, X-Custom-Header2" } } } }, "429": { "description": "Too many requests", "content": { "application/scim+json": { "schema": { "$ref": "#/components/schemas/ScimError" } } }, "headers": { "Access-Control-Allow-Origin": { "description": "Specify the origin(s) allowed to access the resource", "schema": { "type": "string" }, "example": "*" }, "Access-Control-Allow-Methods": { "description": "Specify the HTTP methods allowed when accessing the resource", "schema": { "type": "string" }, "example": "POST, OPTIONS" }, "Access-Control-Allow-Headers": { "description": "Specify the headers allowed when accessing the resource", "schema": { "type": "string" }, "example": "Content-Type, Authorization" }, "Access-Control-Allow-Credentials": { "description": "Indicates whether the browser should include credentials", "schema": { "type": "boolean" } }, "Access-Control-Expose-Headers": { "description": "Headers exposed to the client", "schema": { "type": "string", "example": "X-Custom-Header1, X-Custom-Header2" } } } } } } }, "/Organizations/{OrganizationSid}/scim/Users/{UserSid}": { "servers": [ { "url": "https://preview-iam.twilio.com" } ], "get": { "tags": [ "SCIM" ], "summary": "Get SCIM User", "operationId": "FetchOrganizationUser", "parameters": [ { "name": "OrganizationSid", "in": "path", "required": true, "schema": { "pattern": "OR[0-9a-f]{32}", "type": "string", "format": "OrganizationSid", "example": "OR5f3baf01a0f8273e74266afb84341766" } }, { "name": "UserSid", "in": "path", "required": true, "schema": { "pattern": "US[0-9a-f]{32}", "type": "string", "format": "UserSid", "example": "USb51dccce9ac8e67b938253c7bcaa4f45" } } ], "responses": { "200": { "description": "User", "content": { "application/scim+json": { "schema": { "$ref": "#/components/schemas/ScimUser" } } }, "headers": { "Access-Control-Allow-Origin": { "description": "Specify the origin(s) allowed to access the resource", "schema": { "type": "string" }, "example": "*" }, "Access-Control-Allow-Methods": { "description": "Specify the HTTP methods allowed when accessing the resource", "schema": { "type": "string" }, "example": "POST, OPTIONS" }, "Access-Control-Allow-Headers": { "description": "Specify the headers allowed when accessing the resource", "schema": { "type": "string" }, "example": "Content-Type, Authorization" }, "Access-Control-Allow-Credentials": { "description": "Indicates whether the browser should include credentials", "schema": { "type": "boolean" } }, "Access-Control-Expose-Headers": { "description": "Headers exposed to the client", "schema": { "type": "string", "example": "X-Custom-Header1, X-Custom-Header2" } } } }, "400": { "description": "Bad request or business rules violation", "content": { "application/scim+json": { "schema": { "$ref": "#/components/schemas/ScimError" } } }, "headers": { "Access-Control-Allow-Origin": { "description": "Specify the origin(s) allowed to access the resource", "schema": { "type": "string" }, "example": "*" }, "Access-Control-Allow-Methods": { "description": "Specify the HTTP methods allowed when accessing the resource", "schema": { "type": "string" }, "example": "POST, OPTIONS" }, "Access-Control-Allow-Headers": { "description": "Specify the headers allowed when accessing the resource", "schema": { "type": "string" }, "example": "Content-Type, Authorization" }, "Access-Control-Allow-Credentials": { "description": "Indicates whether the browser should include credentials", "schema": { "type": "boolean" } }, "Access-Control-Expose-Headers": { "description": "Headers exposed to the client", "schema": { "type": "string", "example": "X-Custom-Header1, X-Custom-Header2" } } } }, "401": { "description": "Unauthorized", "content": { "application/scim+json": { "schema": { "$ref": "#/components/schemas/ScimError" } } }, "headers": { "Access-Control-Allow-Origin": { "description": "Specify the origin(s) allowed to access the resource", "schema": { "type": "string" }, "example": "*" }, "Access-Control-Allow-Methods": { "description": "Specify the HTTP methods allowed when accessing the resource", "schema": { "type": "string" }, "example": "POST, OPTIONS" }, "Access-Control-Allow-Headers": { "description": "Specify the headers allowed when accessing the resource", "schema": { "type": "string" }, "example": "Content-Type, Authorization" }, "Access-Control-Allow-Credentials": { "description": "Indicates whether the browser should include credentials", "schema": { "type": "boolean" } }, "Access-Control-Expose-Headers": { "description": "Headers exposed to the client", "schema": { "type": "string", "example": "X-Custom-Header1, X-Custom-Header2" } } } }, "403": { "description": "Forbidden", "content": { "application/scim+json": { "schema": { "$ref": "#/components/schemas/ScimError" } } }, "headers": { "Access-Control-Allow-Origin": { "description": "Specify the origin(s) allowed to access the resource", "schema": { "type": "string" }, "example": "*" }, "Access-Control-Allow-Methods": { "description": "Specify the HTTP methods allowed when accessing the resource", "schema": { "type": "string" }, "example": "POST, OPTIONS" }, "Access-Control-Allow-Headers": { "description": "Specify the headers allowed when accessing the resource", "schema": { "type": "string" }, "example": "Content-Type, Authorization" }, "Access-Control-Allow-Credentials": { "description": "Indicates whether the browser should include credentials", "schema": { "type": "boolean" } }, "Access-Control-Expose-Headers": { "description": "Headers exposed to the client", "schema": { "type": "string", "example": "X-Custom-Header1, X-Custom-Header2" } } } }, "404": { "description": "Not found", "content": { "application/scim+json": { "schema": { "$ref": "#/components/schemas/ScimError" } } }, "headers": { "Access-Control-Allow-Origin": { "description": "Specify the origin(s) allowed to access the resource", "schema": { "type": "string" }, "example": "*" }, "Access-Control-Allow-Methods": { "description": "Specify the HTTP methods allowed when accessing the resource", "schema": { "type": "string" }, "example": "POST, OPTIONS" }, "Access-Control-Allow-Headers": { "description": "Specify the headers allowed when accessing the resource", "schema": { "type": "string" }, "example": "Content-Type, Authorization" }, "Access-Control-Allow-Credentials": { "description": "Indicates whether the browser should include credentials", "schema": { "type": "boolean" } }, "Access-Control-Expose-Headers": { "description": "Headers exposed to the client", "schema": { "type": "string", "example": "X-Custom-Header1, X-Custom-Header2" } } } }, "429": { "description": "Too many requests", "content": { "application/scim+json": { "schema": { "$ref": "#/components/schemas/ScimError" } } }, "headers": { "Access-Control-Allow-Origin": { "description": "Specify the origin(s) allowed to access the resource", "schema": { "type": "string" }, "example": "*" }, "Access-Control-Allow-Methods": { "description": "Specify the HTTP methods allowed when accessing the resource", "schema": { "type": "string" }, "example": "POST, OPTIONS" }, "Access-Control-Allow-Headers": { "description": "Specify the headers allowed when accessing the resource", "schema": { "type": "string" }, "example": "Content-Type, Authorization" }, "Access-Control-Allow-Credentials": { "description": "Indicates whether the browser should include credentials", "schema": { "type": "boolean" } }, "Access-Control-Expose-Headers": { "description": "Headers exposed to the client", "schema": { "type": "string", "example": "X-Custom-Header1, X-Custom-Header2" } } } } } }, "put": { "tags": [ "SCIM" ], "summary": "Update SCIM User", "operationId": "UpdateOrganizationUser", "parameters": [ { "name": "If-Match", "in": "header", "schema": { "type": "string" } }, { "name": "OrganizationSid", "in": "path", "required": true, "schema": { "pattern": "OR[0-9a-f]{32}", "type": "string", "format": "OrganizationSid", "example": "ORd3a1c06d4942d123cd8fa2a052fe110a" } }, { "name": "UserSid", "in": "path", "required": true, "schema": { "pattern": "US[0-9a-f]{32}", "type": "string", "format": "UserSid", "example": "US14def5586bc0799a5c7aab80247af278" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ScimUser" } }, "application/scim+json": { "schema": { "$ref": "#/components/schemas/ScimUser" } } }, "required": true }, "responses": { "200": { "description": "User object with updated attributes", "content": { "application/scim+json": { "schema": { "$ref": "#/components/schemas/ScimUser" } } }, "headers": { "Access-Control-Allow-Origin": { "description": "Specify the origin(s) allowed to access the resource", "schema": { "type": "string" }, "example": "*" }, "Access-Control-Allow-Methods": { "description": "Specify the HTTP methods allowed when accessing the resource", "schema": { "type": "string" }, "example": "POST, OPTIONS" }, "Access-Control-Allow-Headers": { "description": "Specify the headers allowed when accessing the resource", "schema": { "type": "string" }, "example": "Content-Type, Authorization" }, "Access-Control-Allow-Credentials": { "description": "Indicates whether the browser should include credentials", "schema": { "type": "boolean" } }, "Access-Control-Expose-Headers": { "description": "Headers exposed to the client", "schema": { "type": "string", "example": "X-Custom-Header1, X-Custom-Header2" } } } }, "400": { "description": "Bad request or business rules violation", "content": { "application/scim+json": { "schema": { "$ref": "#/components/schemas/ScimError" } } }, "headers": { "Access-Control-Allow-Origin": { "description": "Specify the origin(s) allowed to access the resource", "schema": { "type": "string" }, "example": "*" }, "Access-Control-Allow-Methods": { "description": "Specify the HTTP methods allowed when accessing the resource", "schema": { "type": "string" }, "example": "POST, OPTIONS" }, "Access-Control-Allow-Headers": { "description": "Specify the headers allowed when accessing the resource", "schema": { "type": "string" }, "example": "Content-Type, Authorization" }, "Access-Control-Allow-Credentials": { "description": "Indicates whether the browser should include credentials", "schema": { "type": "boolean" } }, "Access-Control-Expose-Headers": { "description": "Headers exposed to the client", "schema": { "type": "string", "example": "X-Custom-Header1, X-Custom-Header2" } } } }, "401": { "description": "Unauthorized", "content": { "application/scim+json": { "schema": { "$ref": "#/components/schemas/ScimError" } } }, "headers": { "Access-Control-Allow-Origin": { "description": "Specify the origin(s) allowed to access the resource", "schema": { "type": "string" }, "example": "*" }, "Access-Control-Allow-Methods": { "description": "Specify the HTTP methods allowed when accessing the resource", "schema": { "type": "string" }, "example": "POST, OPTIONS" }, "Access-Control-Allow-Headers": { "description": "Specify the headers allowed when accessing the resource", "schema": { "type": "string" }, "example": "Content-Type, Authorization" }, "Access-Control-Allow-Credentials": { "description": "Indicates whether the browser should include credentials", "schema": { "type": "boolean" } }, "Access-Control-Expose-Headers": { "description": "Headers exposed to the client", "schema": { "type": "string", "example": "X-Custom-Header1, X-Custom-Header2" } } } }, "403": { "description": "Forbidden", "content": { "application/scim+json": { "schema": { "$ref": "#/components/schemas/ScimError" } } }, "headers": { "Access-Control-Allow-Origin": { "description": "Specify the origin(s) allowed to access the resource", "schema": { "type": "string" }, "example": "*" }, "Access-Control-Allow-Methods": { "description": "Specify the HTTP methods allowed when accessing the resource", "schema": { "type": "string" }, "example": "POST, OPTIONS" }, "Access-Control-Allow-Headers": { "description": "Specify the headers allowed when accessing the resource", "schema": { "type": "string" }, "example": "Content-Type, Authorization" }, "Access-Control-Allow-Credentials": { "description": "Indicates whether the browser should include credentials", "schema": { "type": "boolean" } }, "Access-Control-Expose-Headers": { "description": "Headers exposed to the client", "schema": { "type": "string", "example": "X-Custom-Header1, X-Custom-Header2" } } } }, "404": { "description": "Not found", "content": { "application/scim+json": { "schema": { "$ref": "#/components/schemas/ScimError" } } }, "headers": { "Access-Control-Allow-Origin": { "description": "Specify the origin(s) allowed to access the resource", "schema": { "type": "string" }, "example": "*" }, "Access-Control-Allow-Methods": { "description": "Specify the HTTP methods allowed when accessing the resource", "schema": { "type": "string" }, "example": "POST, OPTIONS" }, "Access-Control-Allow-Headers": { "description": "Specify the headers allowed when accessing the resource", "schema": { "type": "string" }, "example": "Content-Type, Authorization" }, "Access-Control-Allow-Credentials": { "description": "Indicates whether the browser should include credentials", "schema": { "type": "boolean" } }, "Access-Control-Expose-Headers": { "description": "Headers exposed to the client", "schema": { "type": "string", "example": "X-Custom-Header1, X-Custom-Header2" } } } }, "409": { "description": "Version conflict", "content": { "application/scim+json": { "schema": { "$ref": "#/components/schemas/ScimError" } } }, "headers": { "Access-Control-Allow-Origin": { "description": "Specify the origin(s) allowed to access the resource", "schema": { "type": "string" }, "example": "*" }, "Access-Control-Allow-Methods": { "description": "Specify the HTTP methods allowed when accessing the resource", "schema": { "type": "string" }, "example": "POST, OPTIONS" }, "Access-Control-Allow-Headers": { "description": "Specify the headers allowed when accessing the resource", "schema": { "type": "string" }, "example": "Content-Type, Authorization" }, "Access-Control-Allow-Credentials": { "description": "Indicates whether the browser should include credentials", "schema": { "type": "boolean" } }, "Access-Control-Expose-Headers": { "description": "Headers exposed to the client", "schema": { "type": "string", "example": "X-Custom-Header1, X-Custom-Header2" } } } }, "429": { "description": "Too many requests", "content": { "application/scim+json": { "schema": { "$ref": "#/components/schemas/ScimError" } } }, "headers": { "Access-Control-Allow-Origin": { "description": "Specify the origin(s) allowed to access the resource", "schema": { "type": "string" }, "example": "*" }, "Access-Control-Allow-Methods": { "description": "Specify the HTTP methods allowed when accessing the resource", "schema": { "type": "string" }, "example": "POST, OPTIONS" }, "Access-Control-Allow-Headers": { "description": "Specify the headers allowed when accessing the resource", "schema": { "type": "string" }, "example": "Content-Type, Authorization" }, "Access-Control-Allow-Credentials": { "description": "Indicates whether the browser should include credentials", "schema": { "type": "boolean" } }, "Access-Control-Expose-Headers": { "description": "Headers exposed to the client", "schema": { "type": "string", "example": "X-Custom-Header1, X-Custom-Header2" } } } } } }, "delete": { "tags": [ "SCIM" ], "summary": "Delete SCIM User", "operationId": "DeleteOrganizationUser", "parameters": [ { "name": "OrganizationSid", "in": "path", "required": true, "schema": { "pattern": "OR[0-9a-f]{32}", "type": "string", "format": "OrganizationSid", "example": "OR80b7392892f0a424d07c42f5b11dce2a" } }, { "name": "UserSid", "in": "path", "required": true, "schema": { "pattern": "US[0-9a-f]{32}", "type": "string", "format": "UserSid", "example": "US23c7d4510f1398849aaac5c543475b12" } } ], "responses": { "204": { "description": "No content", "headers": { "Access-Control-Allow-Origin": { "description": "Specify the origin(s) allowed to access the resource", "schema": { "type": "string" }, "example": "*" }, "Access-Control-Allow-Methods": { "description": "Specify the HTTP methods allowed when accessing the resource", "schema": { "type": "string" }, "example": "POST, OPTIONS" }, "Access-Control-Allow-Headers": { "description": "Specify the headers allowed when accessing the resource", "schema": { "type": "string" }, "example": "Content-Type, Authorization" }, "Access-Control-Allow-Credentials": { "description": "Indicates whether the browser should include credentials", "schema": { "type": "boolean" } }, "Access-Control-Expose-Headers": { "description": "Headers exposed to the client", "schema": { "type": "string", "example": "X-Custom-Header1, X-Custom-Header2" } } } }, "400": { "description": "Bad request or business rules violation", "content": { "application/scim+json": { "schema": { "$ref": "#/components/schemas/ScimError" } } }, "headers": { "Access-Control-Allow-Origin": { "description": "Specify the origin(s) allowed to access the resource", "schema": { "type": "string" }, "example": "*" }, "Access-Control-Allow-Methods": { "description": "Specify the HTTP methods allowed when accessing the resource", "schema": { "type": "string" }, "example": "POST, OPTIONS" }, "Access-Control-Allow-Headers": { "description": "Specify the headers allowed when accessing the resource", "schema": { "type": "string" }, "example": "Content-Type, Authorization" }, "Access-Control-Allow-Credentials": { "description": "Indicates whether the browser should include credentials", "schema": { "type": "boolean" } }, "Access-Control-Expose-Headers": { "description": "Headers exposed to the client", "schema": { "type": "string", "example": "X-Custom-Header1, X-Custom-Header2" } } } }, "401": { "description": "Unauthorized", "content": { "application/scim+json": { "schema": { "$ref": "#/components/schemas/ScimError" } } }, "headers": { "Access-Control-Allow-Origin": { "description": "Specify the origin(s) allowed to access the resource", "schema": { "type": "string" }, "example": "*" }, "Access-Control-Allow-Methods": { "description": "Specify the HTTP methods allowed when accessing the resource", "schema": { "type": "string" }, "example": "POST, OPTIONS" }, "Access-Control-Allow-Headers": { "description": "Specify the headers allowed when accessing the resource", "schema": { "type": "string" }, "example": "Content-Type, Authorization" }, "Access-Control-Allow-Credentials": { "description": "Indicates whether the browser should include credentials", "schema": { "type": "boolean" } }, "Access-Control-Expose-Headers": { "description": "Headers exposed to the client", "schema": { "type": "string", "example": "X-Custom-Header1, X-Custom-Header2" } } } }, "403": { "description": "Forbidden", "content": { "application/scim+json": { "schema": { "$ref": "#/components/schemas/ScimError" } } }, "headers": { "Access-Control-Allow-Origin": { "description": "Specify the origin(s) allowed to access the resource", "schema": { "type": "string" }, "example": "*" }, "Access-Control-Allow-Methods": { "description": "Specify the HTTP methods allowed when accessing the resource", "schema": { "type": "string" }, "example": "POST, OPTIONS" }, "Access-Control-Allow-Headers": { "description": "Specify the headers allowed when accessing the resource", "schema": { "type": "string" }, "example": "Content-Type, Authorization" }, "Access-Control-Allow-Credentials": { "description": "Indicates whether the browser should include credentials", "schema": { "type": "boolean" } }, "Access-Control-Expose-Headers": { "description": "Headers exposed to the client", "schema": { "type": "string", "example": "X-Custom-Header1, X-Custom-Header2" } } } }, "404": { "description": "Not found", "content": { "application/scim+json": { "schema": { "$ref": "#/components/schemas/ScimError" } } }, "headers": { "Access-Control-Allow-Origin": { "description": "Specify the origin(s) allowed to access the resource", "schema": { "type": "string" }, "example": "*" }, "Access-Control-Allow-Methods": { "description": "Specify the HTTP methods allowed when accessing the resource", "schema": { "type": "string" }, "example": "POST, OPTIONS" }, "Access-Control-Allow-Headers": { "description": "Specify the headers allowed when accessing the resource", "schema": { "type": "string" }, "example": "Content-Type, Authorization" }, "Access-Control-Allow-Credentials": { "description": "Indicates whether the browser should include credentials", "schema": { "type": "boolean" } }, "Access-Control-Expose-Headers": { "description": "Headers exposed to the client", "schema": { "type": "string", "example": "X-Custom-Header1, X-Custom-Header2" } } } }, "429": { "description": "Too many requests", "content": { "application/scim+json": { "schema": { "$ref": "#/components/schemas/ScimError" } } }, "headers": { "Access-Control-Allow-Origin": { "description": "Specify the origin(s) allowed to access the resource", "schema": { "type": "string" }, "example": "*" }, "Access-Control-Allow-Methods": { "description": "Specify the HTTP methods allowed when accessing the resource", "schema": { "type": "string" }, "example": "POST, OPTIONS" }, "Access-Control-Allow-Headers": { "description": "Specify the headers allowed when accessing the resource", "schema": { "type": "string" }, "example": "Content-Type, Authorization" }, "Access-Control-Allow-Credentials": { "description": "Indicates whether the browser should include credentials", "schema": { "type": "boolean" } }, "Access-Control-Expose-Headers": { "description": "Headers exposed to the client", "schema": { "type": "string", "example": "X-Custom-Header1, X-Custom-Header2" } } } } } }, "patch": { "tags": [ "SCIM" ], "summary": "Patch SCIM User", "operationId": "PatchOrganizationUser", "parameters": [ { "name": "If-Match", "in": "header", "schema": { "type": "string" } }, { "name": "OrganizationSid", "in": "path", "required": true, "schema": { "pattern": "OR[0-9a-f]{32}", "type": "string", "format": "OrganizationSid", "example": "OR50835cc756f1a5503f7a88f23409bd4b" } }, { "name": "UserSid", "in": "path", "required": true, "schema": { "pattern": "US[0-9a-f]{32}", "type": "string", "format": "UserSid", "example": "USa9ddadb0ff7a25ac0ace028a1846729f" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ScimPatchRequest" } }, "application/scim+json": { "schema": { "$ref": "#/components/schemas/ScimPatchRequest" } } }, "required": true }, "responses": { "200": { "description": "User object with updated attributes", "content": { "application/scim+json": { "schema": { "$ref": "#/components/schemas/ScimUser" } } }, "headers": { "Access-Control-Allow-Origin": { "description": "Specify the origin(s) allowed to access the resource", "schema": { "type": "string" }, "example": "*" }, "Access-Control-Allow-Methods": { "description": "Specify the HTTP methods allowed when accessing the resource", "schema": { "type": "string" }, "example": "POST, OPTIONS" }, "Access-Control-Allow-Headers": { "description": "Specify the headers allowed when accessing the resource", "schema": { "type": "string" }, "example": "Content-Type, Authorization" }, "Access-Control-Allow-Credentials": { "description": "Indicates whether the browser should include credentials", "schema": { "type": "boolean" } }, "Access-Control-Expose-Headers": { "description": "Headers exposed to the client", "schema": { "type": "string", "example": "X-Custom-Header1, X-Custom-Header2" } } } }, "400": { "description": "Bad request or business rules violation", "content": { "application/scim+json": { "schema": { "$ref": "#/components/schemas/ScimError" } } }, "headers": { "Access-Control-Allow-Origin": { "description": "Specify the origin(s) allowed to access the resource", "schema": { "type": "string" }, "example": "*" }, "Access-Control-Allow-Methods": { "description": "Specify the HTTP methods allowed when accessing the resource", "schema": { "type": "string" }, "example": "POST, OPTIONS" }, "Access-Control-Allow-Headers": { "description": "Specify the headers allowed when accessing the resource", "schema": { "type": "string" }, "example": "Content-Type, Authorization" }, "Access-Control-Allow-Credentials": { "description": "Indicates whether the browser should include credentials", "schema": { "type": "boolean" } }, "Access-Control-Expose-Headers": { "description": "Headers exposed to the client", "schema": { "type": "string", "example": "X-Custom-Header1, X-Custom-Header2" } } } }, "401": { "description": "Unauthorized", "content": { "application/scim+json": { "schema": { "$ref": "#/components/schemas/ScimError" } } }, "headers": { "Access-Control-Allow-Origin": { "description": "Specify the origin(s) allowed to access the resource", "schema": { "type": "string" }, "example": "*" }, "Access-Control-Allow-Methods": { "description": "Specify the HTTP methods allowed when accessing the resource", "schema": { "type": "string" }, "example": "POST, OPTIONS" }, "Access-Control-Allow-Headers": { "description": "Specify the headers allowed when accessing the resource", "schema": { "type": "string" }, "example": "Content-Type, Authorization" }, "Access-Control-Allow-Credentials": { "description": "Indicates whether the browser should include credentials", "schema": { "type": "boolean" } }, "Access-Control-Expose-Headers": { "description": "Headers exposed to the client", "schema": { "type": "string", "example": "X-Custom-Header1, X-Custom-Header2" } } } }, "403": { "description": "Forbidden", "content": { "application/scim+json": { "schema": { "$ref": "#/components/schemas/ScimError" } } }, "headers": { "Access-Control-Allow-Origin": { "description": "Specify the origin(s) allowed to access the resource", "schema": { "type": "string" }, "example": "*" }, "Access-Control-Allow-Methods": { "description": "Specify the HTTP methods allowed when accessing the resource", "schema": { "type": "string" }, "example": "POST, OPTIONS" }, "Access-Control-Allow-Headers": { "description": "Specify the headers allowed when accessing the resource", "schema": { "type": "string" }, "example": "Content-Type, Authorization" }, "Access-Control-Allow-Credentials": { "description": "Indicates whether the browser should include credentials", "schema": { "type": "boolean" } }, "Access-Control-Expose-Headers": { "description": "Headers exposed to the client", "schema": { "type": "string", "example": "X-Custom-Header1, X-Custom-Header2" } } } }, "404": { "description": "Not found", "content": { "application/scim+json": { "schema": { "$ref": "#/components/schemas/ScimError" } } }, "headers": { "Access-Control-Allow-Origin": { "description": "Specify the origin(s) allowed to access the resource", "schema": { "type": "string" }, "example": "*" }, "Access-Control-Allow-Methods": { "description": "Specify the HTTP methods allowed when accessing the resource", "schema": { "type": "string" }, "example": "POST, OPTIONS" }, "Access-Control-Allow-Headers": { "description": "Specify the headers allowed when accessing the resource", "schema": { "type": "string" }, "example": "Content-Type, Authorization" }, "Access-Control-Allow-Credentials": { "description": "Indicates whether the browser should include credentials", "schema": { "type": "boolean" } }, "Access-Control-Expose-Headers": { "description": "Headers exposed to the client", "schema": { "type": "string", "example": "X-Custom-Header1, X-Custom-Header2" } } } }, "409": { "description": "Version conflict", "content": { "application/scim+json": { "schema": { "$ref": "#/components/schemas/ScimError" } } }, "headers": { "Access-Control-Allow-Origin": { "description": "Specify the origin(s) allowed to access the resource", "schema": { "type": "string" }, "example": "*" }, "Access-Control-Allow-Methods": { "description": "Specify the HTTP methods allowed when accessing the resource", "schema": { "type": "string" }, "example": "POST, OPTIONS" }, "Access-Control-Allow-Headers": { "description": "Specify the headers allowed when accessing the resource", "schema": { "type": "string" }, "example": "Content-Type, Authorization" }, "Access-Control-Allow-Credentials": { "description": "Indicates whether the browser should include credentials", "schema": { "type": "boolean" } }, "Access-Control-Expose-Headers": { "description": "Headers exposed to the client", "schema": { "type": "string", "example": "X-Custom-Header1, X-Custom-Header2" } } } }, "429": { "description": "Too many requests", "content": { "application/scim+json": { "schema": { "$ref": "#/components/schemas/ScimError" } } }, "headers": { "Access-Control-Allow-Origin": { "description": "Specify the origin(s) allowed to access the resource", "schema": { "type": "string" }, "example": "*" }, "Access-Control-Allow-Methods": { "description": "Specify the HTTP methods allowed when accessing the resource", "schema": { "type": "string" }, "example": "POST, OPTIONS" }, "Access-Control-Allow-Headers": { "description": "Specify the headers allowed when accessing the resource", "schema": { "type": "string" }, "example": "Content-Type, Authorization" }, "Access-Control-Allow-Credentials": { "description": "Indicates whether the browser should include credentials", "schema": { "type": "boolean" } }, "Access-Control-Expose-Headers": { "description": "Headers exposed to the client", "schema": { "type": "string", "example": "X-Custom-Header1, X-Custom-Header2" } } } } } } }, "/Organizations/{OrganizationSid}/Accounts": { "servers": [ { "url": "https://preview-iam.twilio.com" } ], "get": { "tags": [ "OrganizationAccounts" ], "summary": "List organization accounts", "operationId": "ListOrganizationAccounts", "parameters": [ { "name": "OrganizationSid", "in": "path", "required": true, "schema": { "pattern": "OR[0-9a-f]{32}", "type": "string", "format": "OrganizationSid", "example": "ORa36de9717566c7eb6363671f54b87ba9" } }, { "name": "PageSize", "in": "query", "schema": { "maximum": 100, "minimum": 1, "type": "integer", "format": "int32", "default": 50 } }, { "name": "PageToken", "in": "query", "schema": { "maxLength": 4096, "minLength": 1, "type": "string" } } ], "responses": { "200": { "description": "Organization account list", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicApiAccountResponsePage" } } }, "headers": { "Access-Control-Allow-Origin": { "description": "Specify the origin(s) allowed to access the resource", "schema": { "type": "string" }, "example": "*" }, "Access-Control-Allow-Methods": { "description": "Specify the HTTP methods allowed when accessing the resource", "schema": { "type": "string" }, "example": "POST, OPTIONS" }, "Access-Control-Allow-Headers": { "description": "Specify the headers allowed when accessing the resource", "schema": { "type": "string" }, "example": "Content-Type, Authorization" }, "Access-Control-Allow-Credentials": { "description": "Indicates whether the browser should include credentials", "schema": { "type": "boolean" } }, "Access-Control-Expose-Headers": { "description": "Headers exposed to the client", "schema": { "type": "string", "example": "X-Custom-Header1, X-Custom-Header2" } } } }, "403": { "description": "Unauthorized", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "description": "Twilio-specific error code", "type": "integer", "format": "int32" }, "message": { "description": "Error message", "type": "string" }, "more_info": { "description": "Link to Error Code References", "type": "string" }, "status": { "description": "HTTP response status code", "type": "integer", "format": "int32" } } } } }, "headers": { "Access-Control-Allow-Origin": { "description": "Specify the origin(s) allowed to access the resource", "schema": { "type": "string" }, "example": "*" }, "Access-Control-Allow-Methods": { "description": "Specify the HTTP methods allowed when accessing the resource", "schema": { "type": "string" }, "example": "POST, OPTIONS" }, "Access-Control-Allow-Headers": { "description": "Specify the headers allowed when accessing the resource", "schema": { "type": "string" }, "example": "Content-Type, Authorization" }, "Access-Control-Allow-Credentials": { "description": "Indicates whether the browser should include credentials", "schema": { "type": "boolean" } }, "Access-Control-Expose-Headers": { "description": "Headers exposed to the client", "schema": { "type": "string", "example": "X-Custom-Header1, X-Custom-Header2" } } } }, "404": { "description": "Account not found", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "description": "Twilio-specific error code", "type": "integer", "format": "int32" }, "message": { "description": "Error message", "type": "string" }, "more_info": { "description": "Link to Error Code References", "type": "string" }, "status": { "description": "HTTP response status code", "type": "integer", "format": "int32" } } } } }, "headers": { "Access-Control-Allow-Origin": { "description": "Specify the origin(s) allowed to access the resource", "schema": { "type": "string" }, "example": "*" }, "Access-Control-Allow-Methods": { "description": "Specify the HTTP methods allowed when accessing the resource", "schema": { "type": "string" }, "example": "POST, OPTIONS" }, "Access-Control-Allow-Headers": { "description": "Specify the headers allowed when accessing the resource", "schema": { "type": "string" }, "example": "Content-Type, Authorization" }, "Access-Control-Allow-Credentials": { "description": "Indicates whether the browser should include credentials", "schema": { "type": "boolean" } }, "Access-Control-Expose-Headers": { "description": "Headers exposed to the client", "schema": { "type": "string", "example": "X-Custom-Header1, X-Custom-Header2" } } } } } } }, "/Organizations/{OrganizationSid}/Accounts/{AccountSid}": { "servers": [ { "url": "https://preview-iam.twilio.com" } ], "get": { "tags": [ "OrganizationAccounts" ], "summary": "Get details of organization account", "operationId": "FetchOrganizationAccount", "parameters": [ { "name": "OrganizationSid", "in": "path", "required": true, "schema": { "pattern": "OR[0-9a-f]{32}", "type": "string", "format": "OrganizationSid", "example": "ORf9618e7f043b4bc13832e4946fde06c9" } }, { "name": "AccountSid", "in": "path", "required": true, "schema": { "pattern": "AC[0-9a-f]{32}", "type": "string", "format": "AccountSid", "example": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" } } ], "responses": { "200": { "description": "Get details of organization account", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicApiAccountResponse" } } }, "headers": { "Access-Control-Allow-Origin": { "description": "Specify the origin(s) allowed to access the resource", "schema": { "type": "string" }, "example": "*" }, "Access-Control-Allow-Methods": { "description": "Specify the HTTP methods allowed when accessing the resource", "schema": { "type": "string" }, "example": "POST, OPTIONS" }, "Access-Control-Allow-Headers": { "description": "Specify the headers allowed when accessing the resource", "schema": { "type": "string" }, "example": "Content-Type, Authorization" }, "Access-Control-Allow-Credentials": { "description": "Indicates whether the browser should include credentials", "schema": { "type": "boolean" } }, "Access-Control-Expose-Headers": { "description": "Headers exposed to the client", "schema": { "type": "string", "example": "X-Custom-Header1, X-Custom-Header2" } } } }, "403": { "description": "Unauthorized", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "description": "Twilio-specific error code", "type": "integer", "format": "int32" }, "message": { "description": "Error message", "type": "string" }, "more_info": { "description": "Link to Error Code References", "type": "string" }, "status": { "description": "HTTP response status code", "type": "integer", "format": "int32" } } } } }, "headers": { "Access-Control-Allow-Origin": { "description": "Specify the origin(s) allowed to access the resource", "schema": { "type": "string" }, "example": "*" }, "Access-Control-Allow-Methods": { "description": "Specify the HTTP methods allowed when accessing the resource", "schema": { "type": "string" }, "example": "POST, OPTIONS" }, "Access-Control-Allow-Headers": { "description": "Specify the headers allowed when accessing the resource", "schema": { "type": "string" }, "example": "Content-Type, Authorization" }, "Access-Control-Allow-Credentials": { "description": "Indicates whether the browser should include credentials", "schema": { "type": "boolean" } }, "Access-Control-Expose-Headers": { "description": "Headers exposed to the client", "schema": { "type": "string", "example": "X-Custom-Header1, X-Custom-Header2" } } } }, "404": { "description": "Account does not belong to Organization", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "description": "Twilio-specific error code", "type": "integer", "format": "int32" }, "message": { "description": "Error message", "type": "string" }, "more_info": { "description": "Link to Error Code References", "type": "string" }, "status": { "description": "HTTP response status code", "type": "integer", "format": "int32" } } } } }, "headers": { "Access-Control-Allow-Origin": { "description": "Specify the origin(s) allowed to access the resource", "schema": { "type": "string" }, "example": "*" }, "Access-Control-Allow-Methods": { "description": "Specify the HTTP methods allowed when accessing the resource", "schema": { "type": "string" }, "example": "POST, OPTIONS" }, "Access-Control-Allow-Headers": { "description": "Specify the headers allowed when accessing the resource", "schema": { "type": "string" }, "example": "Content-Type, Authorization" }, "Access-Control-Allow-Credentials": { "description": "Indicates whether the browser should include credentials", "schema": { "type": "boolean" } }, "Access-Control-Expose-Headers": { "description": "Headers exposed to the client", "schema": { "type": "string", "example": "X-Custom-Header1, X-Custom-Header2" } } } } } } }, "/Organizations/{OrganizationSid}/RoleAssignments": { "servers": [ { "url": "https://preview-iam.twilio.com" } ], "get": { "tags": [ "RoleAssignments" ], "summary": "List role assignments", "description": "List role assignments for the given organization", "operationId": "ListRoleAssignments", "parameters": [ { "name": "OrganizationSid", "in": "path", "required": true, "schema": { "pattern": "OR[0-9a-f]{32}", "type": "string", "format": "OrganizationSid", "example": "OR33f4f3aa6fffe840d000f8ef22e883db" } }, { "name": "PageSize", "in": "query", "schema": { "maximum": 100, "minimum": 1, "type": "integer", "format": "int32", "default": 100 } }, { "name": "PageToken", "in": "query", "schema": { "maxLength": 4096, "minLength": 1, "type": "string" } }, { "name": "Identity", "in": "query", "required": false, "schema": { "pattern": "^[A-Z]{2}[0-9a-fA-F]{32}$", "type": "string", "format": "Sid", "example": "USa36de9717566c7eb6363671f54b87ba9" } }, { "name": "Scope", "in": "query", "required": false, "schema": { "pattern": "^[A-Z]{2}[0-9a-fA-F]{32}$", "type": "string", "format": "Sid", "example": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" } } ], "responses": { "200": { "description": "Returned list of role assignments", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicApiCreateRoleAssignmentResponsePage" } } }, "headers": { "Access-Control-Allow-Origin": { "description": "Specify the origin(s) allowed to access the resource", "schema": { "type": "string" }, "example": "*" }, "Access-Control-Allow-Methods": { "description": "Specify the HTTP methods allowed when accessing the resource", "schema": { "type": "string" }, "example": "POST, OPTIONS" }, "Access-Control-Allow-Headers": { "description": "Specify the headers allowed when accessing the resource", "schema": { "type": "string" }, "example": "Content-Type, Authorization" }, "Access-Control-Allow-Credentials": { "description": "Indicates whether the browser should include credentials", "schema": { "type": "boolean" } }, "Access-Control-Expose-Headers": { "description": "Headers exposed to the client", "schema": { "type": "string", "example": "X-Custom-Header1, X-Custom-Header2" } } } }, "400": { "description": "Bad request", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "description": "Twilio-specific error code", "type": "integer", "format": "int32" }, "message": { "description": "Error message", "type": "string" }, "more_info": { "description": "Link to Error Code References", "type": "string" }, "status": { "description": "HTTP response status code", "type": "integer", "format": "int32" } } } } }, "headers": { "Access-Control-Allow-Origin": { "description": "Specify the origin(s) allowed to access the resource", "schema": { "type": "string" }, "example": "*" }, "Access-Control-Allow-Methods": { "description": "Specify the HTTP methods allowed when accessing the resource", "schema": { "type": "string" }, "example": "POST, OPTIONS" }, "Access-Control-Allow-Headers": { "description": "Specify the headers allowed when accessing the resource", "schema": { "type": "string" }, "example": "Content-Type, Authorization" }, "Access-Control-Allow-Credentials": { "description": "Indicates whether the browser should include credentials", "schema": { "type": "boolean" } }, "Access-Control-Expose-Headers": { "description": "Headers exposed to the client", "schema": { "type": "string", "example": "X-Custom-Header1, X-Custom-Header2" } } } }, "403": { "description": "Unauthorized", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "description": "Twilio-specific error code", "type": "integer", "format": "int32" }, "message": { "description": "Error message", "type": "string" }, "more_info": { "description": "Link to Error Code References", "type": "string" }, "status": { "description": "HTTP response status code", "type": "integer", "format": "int32" } } } } }, "headers": { "Access-Control-Allow-Origin": { "description": "Specify the origin(s) allowed to access the resource", "schema": { "type": "string" }, "example": "*" }, "Access-Control-Allow-Methods": { "description": "Specify the HTTP methods allowed when accessing the resource", "schema": { "type": "string" }, "example": "POST, OPTIONS" }, "Access-Control-Allow-Headers": { "description": "Specify the headers allowed when accessing the resource", "schema": { "type": "string" }, "example": "Content-Type, Authorization" }, "Access-Control-Allow-Credentials": { "description": "Indicates whether the browser should include credentials", "schema": { "type": "boolean" } }, "Access-Control-Expose-Headers": { "description": "Headers exposed to the client", "schema": { "type": "string", "example": "X-Custom-Header1, X-Custom-Header2" } } } } } }, "post": { "tags": [ "RoleAssignments" ], "summary": "Create a role assignment", "description": "Create a role assignment for the given organization", "operationId": "CreateRoleAssignment", "parameters": [ { "name": "OrganizationSid", "in": "path", "required": true, "schema": { "pattern": "OR[0-9a-f]{32}", "type": "string", "format": "OrganizationSid", "example": "ORa36de9717566c7eb6363671f54b87ba9" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicApiCreateRoleAssignmentRequest" } } }, "required": true }, "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicApiRoleAssignmentResponse" } } }, "headers": { "Access-Control-Allow-Origin": { "description": "Specify the origin(s) allowed to access the resource", "schema": { "type": "string" }, "example": "*" }, "Access-Control-Allow-Methods": { "description": "Specify the HTTP methods allowed when accessing the resource", "schema": { "type": "string" }, "example": "POST, OPTIONS" }, "Access-Control-Allow-Headers": { "description": "Specify the headers allowed when accessing the resource", "schema": { "type": "string" }, "example": "Content-Type, Authorization" }, "Access-Control-Allow-Credentials": { "description": "Indicates whether the browser should include credentials", "schema": { "type": "boolean" } }, "Access-Control-Expose-Headers": { "description": "Headers exposed to the client", "schema": { "type": "string", "example": "X-Custom-Header1, X-Custom-Header2" } } } }, "400": { "description": "Bad request or business rules violation", "content": { "application/scim+json": { "schema": { "$ref": "#/components/schemas/TwilioServiceErrorResponse" } } }, "headers": { "Access-Control-Allow-Origin": { "description": "Specify the origin(s) allowed to access the resource", "schema": { "type": "string" }, "example": "*" }, "Access-Control-Allow-Methods": { "description": "Specify the HTTP methods allowed when accessing the resource", "schema": { "type": "string" }, "example": "POST, OPTIONS" }, "Access-Control-Allow-Headers": { "description": "Specify the headers allowed when accessing the resource", "schema": { "type": "string" }, "example": "Content-Type, Authorization" }, "Access-Control-Allow-Credentials": { "description": "Indicates whether the browser should include credentials", "schema": { "type": "boolean" } }, "Access-Control-Expose-Headers": { "description": "Headers exposed to the client", "schema": { "type": "string", "example": "X-Custom-Header1, X-Custom-Header2" } } } }, "403": { "description": "Unauthorized", "content": { "application/scim+json": { "schema": { "$ref": "#/components/schemas/TwilioServiceErrorResponse" } } }, "headers": { "Access-Control-Allow-Origin": { "description": "Specify the origin(s) allowed to access the resource", "schema": { "type": "string" }, "example": "*" }, "Access-Control-Allow-Methods": { "description": "Specify the HTTP methods allowed when accessing the resource", "schema": { "type": "string" }, "example": "POST, OPTIONS" }, "Access-Control-Allow-Headers": { "description": "Specify the headers allowed when accessing the resource", "schema": { "type": "string" }, "example": "Content-Type, Authorization" }, "Access-Control-Allow-Credentials": { "description": "Indicates whether the browser should include credentials", "schema": { "type": "boolean" } }, "Access-Control-Expose-Headers": { "description": "Headers exposed to the client", "schema": { "type": "string", "example": "X-Custom-Header1, X-Custom-Header2" } } } } } } }, "/Organizations/{OrganizationSid}/RoleAssignments/{RoleAssignmentSid}": { "servers": [ { "url": "https://preview-iam.twilio.com" } ], "delete": { "tags": [ "RoleAssignments" ], "summary": "Delete a role assignment", "description": "Delete a role assignment for the given organization", "operationId": "DeleteRoleAssignment", "parameters": [ { "name": "OrganizationSid", "in": "path", "required": true, "schema": { "pattern": "OR[0-9a-f]{32}", "type": "string", "format": "OrganizationSid", "example": "ORa36de9717566c7eb6363671f54b87ba9" } }, { "name": "RoleAssignmentSid", "in": "path", "required": true, "schema": { "pattern": "IY[0-9a-f]{32}", "type": "string", "format": "IamRoleAssignmentSid", "example": "IYa36de9717566c7eb6363671f54b87ba9" } } ], "responses": { "204": { "description": "No content", "headers": { "Access-Control-Allow-Origin": { "description": "Specify the origin(s) allowed to access the resource", "schema": { "type": "string" }, "example": "*" }, "Access-Control-Allow-Methods": { "description": "Specify the HTTP methods allowed when accessing the resource", "schema": { "type": "string" }, "example": "POST, OPTIONS" }, "Access-Control-Allow-Headers": { "description": "Specify the headers allowed when accessing the resource", "schema": { "type": "string" }, "example": "Content-Type, Authorization" }, "Access-Control-Allow-Credentials": { "description": "Indicates whether the browser should include credentials", "schema": { "type": "boolean" } }, "Access-Control-Expose-Headers": { "description": "Headers exposed to the client", "schema": { "type": "string", "example": "X-Custom-Header1, X-Custom-Header2" } } } }, "400": { "description": "Invalid request provided", "content": { "application/scim+json": { "schema": { "$ref": "#/components/schemas/TwilioServiceErrorResponse" } } }, "headers": { "Access-Control-Allow-Origin": { "description": "Specify the origin(s) allowed to access the resource", "schema": { "type": "string" }, "example": "*" }, "Access-Control-Allow-Methods": { "description": "Specify the HTTP methods allowed when accessing the resource", "schema": { "type": "string" }, "example": "POST, OPTIONS" }, "Access-Control-Allow-Headers": { "description": "Specify the headers allowed when accessing the resource", "schema": { "type": "string" }, "example": "Content-Type, Authorization" }, "Access-Control-Allow-Credentials": { "description": "Indicates whether the browser should include credentials", "schema": { "type": "boolean" } }, "Access-Control-Expose-Headers": { "description": "Headers exposed to the client", "schema": { "type": "string", "example": "X-Custom-Header1, X-Custom-Header2" } } } }, "403": { "description": "Unauthorized", "content": { "application/scim+json": { "schema": { "$ref": "#/components/schemas/TwilioServiceErrorResponse" } } }, "headers": { "Access-Control-Allow-Origin": { "description": "Specify the origin(s) allowed to access the resource", "schema": { "type": "string" }, "example": "*" }, "Access-Control-Allow-Methods": { "description": "Specify the HTTP methods allowed when accessing the resource", "schema": { "type": "string" }, "example": "POST, OPTIONS" }, "Access-Control-Allow-Headers": { "description": "Specify the headers allowed when accessing the resource", "schema": { "type": "string" }, "example": "Content-Type, Authorization" }, "Access-Control-Allow-Credentials": { "description": "Indicates whether the browser should include credentials", "schema": { "type": "boolean" } }, "Access-Control-Expose-Headers": { "description": "Headers exposed to the client", "schema": { "type": "string", "example": "X-Custom-Header1, X-Custom-Header2" } } } } } } }, "/v1/authorize": { "servers": [ { "url": "https://preview-iam.twilio.com" } ], "x-twilio": { "defaultOutputProperties": [ "redirect_to" ], "pathType": "list" }, "get": { "tags": [ "OauthV1Authorize" ], "security": [], "summary": "Retrieves authorize uri", "operationId": "FetchAuthorize", "parameters": [ { "name": "response_type", "in": "query", "description": "Response Type", "schema": { "type": "string", "example": "code" } }, { "name": "client_id", "in": "query", "description": "The Client Identifier", "schema": { "type": "string", "example": "OQ7cda1a615f05a95634e643aaaf7081d7" } }, { "name": "redirect_uri", "in": "query", "description": "The url to which response will be redirected to", "schema": { "type": "string", "example": "www.twilio.com" } }, { "name": "scope", "in": "query", "description": "The scope of the access request", "schema": { "type": "string", "example": "offline_access" } }, { "name": "state", "in": "query", "description": "An opaque value which can be used to maintain state between the request and callback", "schema": { "type": "string", "example": "xvz" } } ], "responses": { "302": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/oauth.v1.authorize" }, "examples": { "fetch": { "value": { "redirect_to": "https://www.twilio.com/authorize?response_type=code&client_id=OQ7cda1a615f05a95634e643aaaf7081d7&redirect_uri=www.twilio.com&scope=offline_access&state=xvz" } } } } }, "description": "Found" } } } }, "/v1/token": { "servers": [ { "url": "https://preview-iam.twilio.com" } ], "x-twilio": { "defaultOutputProperties": [], "pathType": "list" }, "post": { "security": [], "tags": [ "OauthV1Token" ], "summary": "Issues a new Access token (optionally identity_token & refresh_token) in exchange of Oauth grant", "operationId": "CreateToken", "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/oauth.v1.token" }, "examples": { "create": { "value": { "access_token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c", "refresh_token": "ghjbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c", "id_token": "eyJhbdGciOiIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c", "expires_in": 1438315200000, "token_type": "bearer" } } } } }, "description": "Created" } }, "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { "type": "object", "title": "CreateTokenRequest", "properties": { "grant_type": { "type": "string", "description": "Grant type is a credential representing resource owner's authorization which can be used by client to obtain access token." }, "client_id": { "type": "string", "description": "A 34 character string that uniquely identifies this OAuth App." }, "client_secret": { "type": "string", "description": "The credential for confidential OAuth App." }, "code": { "type": "string", "description": "JWT token related to the authorization code grant type." }, "redirect_uri": { "type": "string", "description": "The redirect uri" }, "audience": { "type": "string", "description": "The targeted audience uri" }, "refresh_token": { "type": "string", "description": "JWT token related to refresh access token." }, "scope": { "type": "string", "description": "The scope of token" } }, "required": [ "grant_type", "client_id" ] }, "examples": { "create": { "value": { "client_id": "OQ7cda1a615f05a95634e643aaaf7081d7", "client_secret": "sUWblrQ4wx_aYkdAWjHXNvHinynkYOgBoiRyEQUeEntpgDEG47qnBFD98yoEzsTh", "grant_type": "client_credentials", "redirect_uri": "", "audience": "", "code": "", "refresh_token": "refresh_token", "scope": "scope" } } } } }, "required": true } } } }, "components": { "securitySchemes": { "oAuth2ClientCredentials": { "type": "oauth2", "flows": { "clientCredentials": { "tokenUrl": "https://preview-iam.twilio.com/v1/token", "scopes": {} } } } }, "schemas": { "ScimUser": { "required": [ "userName" ], "type": "object", "properties": { "id": { "type": "string", "description": "Unique Twilio user sid" }, "externalId": { "maxLength": 255, "minLength": 2, "type": "string", "description": "External unique resource id defined by provisioning client" }, "userName": { "maxLength": 255, "minLength": 2, "type": "string", "description": "Unique username, MUST be same as primary email address" }, "displayName": { "maxLength": 255, "minLength": 0, "type": "string", "description": "User friendly display name" }, "name": { "$ref": "#/components/schemas/ScimName" }, "emails": { "maxItems": 2147483647, "minItems": 1, "type": "array", "description": "Email address list of the user. Primary email must be defined if there are more than 1 email. Primary email must match the username.", "items": { "$ref": "#/components/schemas/ScimEmailAddress" } }, "active": { "type": "boolean", "description": "Indicates whether the user is active" }, "locale": { "type": "string", "description": "User's locale" }, "timezone": { "type": "string", "description": "User's time zone" }, "schemas": { "type": "array", "description": "An array of URIs that indicate the schemas supported for this user resource", "items": { "type": "string", "description": "An array of URIs that indicate the schemas supported for this user resource" } }, "meta": { "$ref": "#/components/schemas/ScimMeta" } } }, "ScimUserPage": { "type": "object", "properties": { "Resources": { "type": "array", "items": { "$ref": "#/components/schemas/ScimUser" } }, "totalResults": { "type": "integer", "format": "int32" }, "schemas": { "type": "array", "items": { "type": "string", "description": "Scim ListResponse schema" } } } }, "ScimEmailAddress": { "type": "object", "properties": { "primary": { "type": "boolean", "description": "Indicates if this email address is the primary one" }, "value": { "maxLength": 160, "minLength": 2, "type": "string", "description": "The actual email address value" }, "type": { "maxLength": 64, "minLength": 0, "type": "string", "description": "The type of email address (e.g., work, home, etc.)" } }, "description": "Email address list of the user. Primary email must be defined if there are more than 1 email. Primary email must match the username." }, "ScimMeta": { "type": "object", "properties": { "resourceType": { "type": "string", "description": "Indicates the type of the resource" }, "created": { "type": "string", "description": "The date and time when the resource was created in the system", "format": "date-time" }, "lastModified": { "type": "string", "description": "The date and time when the resource was last modified", "format": "date-time" }, "version": { "type": "string", "description": "A version identifier for the resource. This can be used to manage resource versioning and concurrency control." } }, "description": "Meta" }, "ScimName": { "type": "object", "properties": { "givenName": { "maxLength": 255, "minLength": 0, "type": "string", "description": "The user's first or given name" }, "familyName": { "maxLength": 255, "minLength": 0, "type": "string", "description": "The user's last or family name" } }, "description": "User's name" }, "ScimResourceTypes": { "type": "object", "properties": { "Resources": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string", "description": "Name of the resource type" }, "description": { "type": "string", "description": "Description of the resource type" }, "endpoint": { "type": "string", "description": "HTTP-addressable endpoint relative to the Base URL of the service provider" }, "schema": { "type": "string", "description": "Primary/base schema URI" } } } } } }, "ScimPatchRequest": { "type": "object", "properties": { "schemas": { "type": "array", "items": { "type": "string" } }, "Operations": { "type": "array", "items": { "$ref": "#/components/schemas/ScimPatchOperation" } } } }, "ScimPatchOperation": { "type": "object", "properties": { "op": { "type": "string", "description": "The operation to perform" }, "path": { "type": "string" }, "value": { "type": "object" } } }, "JsonPatch": { "type": "object", "properties": { "op": { "type": "string", "enum": [ "add", "remove", "replace" ] }, "path": { "type": "string" }, "value": { "type": "string" } } }, "PublicApiCreateAccountRequest": { "required": [ "friendlyName" ], "type": "object", "properties": { "friendlyName": { "maxLength": 255, "minLength": 1, "type": "string", "description": "Account friendly name" }, "ownerSid": { "pattern": "US[0-9a-f]{32}", "type": "string", "description": "Optional owner sid. If not provided, the owner will be the organization owner.", "format": "UserSid", "example": "USa4faef6467378082de67039e533b515a" } } }, "PublicApiCreateAccountResponse": { "type": "object", "properties": { "accountSid": { "pattern": "AC[0-9a-f]{32}", "type": "string", "description": "Twilio account sid for the new account, creation is asynchronous owner.", "format": "AccountSid", "example": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" } } }, "PublicApiAccountResponse": { "type": "object", "properties": { "account_sid": { "pattern": "AC[0-9a-f]{32}", "type": "string", "description": "Twilio account sid", "format": "AccountSid", "example": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" }, "friendly_name": { "type": "string", "description": "Account friendly name" }, "status": { "type": "string", "description": "Account status", "example": "active", "enum": [ "active", "suspended", "pending_closure", "closed" ] }, "owner_sid": { "pattern": "US[0-9a-f]{32}", "type": "string", "description": "Twilio account sid", "format": "UserSid", "example": "US9a6d63d00bdbb50aa1c1889b3066bd30" }, "date_created": { "type": "string", "description": "The date and time when the account was created in the system", "format": "date-time" } }, "description": "Page content" }, "PublicApiAccountResponsePage": { "type": "object", "properties": { "content": { "type": "array", "description": "Page content", "items": { "$ref": "#/components/schemas/PublicApiAccountResponse" } }, "meta": { "properties": { "first_page_url": { "format": "uri", "type": "string" }, "key": { "type": "string" }, "next_page_url": { "format": "uri", "nullable": true, "type": "string" }, "page": { "type": "integer" }, "page_size": { "type": "integer" }, "previous_page_url": { "format": "uri", "nullable": true, "type": "string" }, "url": { "format": "uri", "type": "string" } }, "type": "object" } } }, "PublicApiCreateRoleAssignmentRequest": { "required": [ "role_sid", "scope", "identity" ], "type": "object", "properties": { "role_sid": { "pattern": "IX[0-9a-f]{32}", "type": "string", "description": "Twilio Role Sid representing assigned role", "format": "IamRoleSid", "example": "IXc4ddb9d0befdb122b0eff334e3084544" }, "scope": { "pattern": "^[A-Z]{2}[0-9a-fA-F]{32}$", "type": "string", "description": "Twilio Sid representing scope of this assignment", "format": "Sid", "example": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" }, "identity": { "pattern": "^[A-Z]{2}[0-9a-fA-F]{32}$", "type": "string", "description": "Twilio Sid representing identity of this assignment", "format": "Sid", "example": "USc4ddb9d0befdb122b0eff334e3084544" } } }, "PublicApiCreateRoleAssignmentResponsePage": { "type": "object", "properties": { "content": { "type": "array", "description": "Page content", "items": { "$ref": "#/components/schemas/PublicApiRoleAssignmentResponse" } }, "meta": { "properties": { "first_page_url": { "format": "uri", "type": "string" }, "key": { "type": "string" }, "next_page_url": { "format": "uri", "nullable": true, "type": "string" }, "page": { "type": "integer" }, "page_size": { "type": "integer" }, "previous_page_url": { "format": "uri", "nullable": true, "type": "string" }, "url": { "format": "uri", "type": "string" } }, "type": "object" } } }, "PublicApiRoleAssignmentResponse": { "type": "object", "properties": { "sid": { "pattern": "IY[0-9a-f]{32}", "type": "string", "description": "Twilio Role Assignment Sid representing this role assignment", "format": "IamRoleAssignmentSid", "example": "IYc4ddb9d0befdb122b0eff334e3084544" }, "role_sid": { "pattern": "IX[0-9a-f]{32}", "type": "string", "description": "Twilio Role Sid representing assigned role", "format": "IamRoleSid", "example": "IXc4ddb9d0befdb122b0eff334e3084544" }, "scope": { "pattern": "^[A-Z]{2}[0-9a-fA-F]{32}$", "type": "string", "description": "Twilio Sid representing identity of this assignment", "format": "Sid", "example": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" }, "identity": { "pattern": "^[A-Z]{2}[0-9a-fA-F]{32}$", "type": "string", "description": "Twilio Sid representing scope of this assignment", "format": "Sid", "example": "USc4ddb9d0befdb122b0eff334e3084544" } } }, "TwilioServiceErrorResponse": { "type": "object", "properties": { "code": { "description": "Twilio-specific error code", "type": "integer", "format": "int32" }, "message": { "description": "Error message", "type": "string" }, "moreInfo": { "description": "Link to Error Code References", "type": "string" }, "status": { "description": "HTTP response status code", "type": "integer", "format": "int32" } } }, "ScimError": { "type": "object", "properties": { "schemas": { "type": "array", "description": "Schema URIs that define the contents of the error structure", "items": { "type": "string", "description": "Schema URIs that define the contents of the error structure" } }, "detail": { "type": "string", "description": "A human-readable description of the error" }, "scimType": { "type": "string", "description": "A scimType error code as defined in RFC7644", "enum": [ "invalidFilter", "uniqueness", "mutability", "invalidValue", "invalidSyntax" ] }, "status": { "type": "string", "description": "Http status code" }, "code": { "description": "Twilio-specific error code", "type": "integer", "format": "int32" }, "moreInfo": { "description": "Link to Error Code References", "type": "string" } } }, "oauth.v1.authorize": { "type": "object", "properties": { "redirect_to": { "type": "string", "format": "uri", "nullable": true, "description": "The callback URL" } } }, "oauth.v1.token": { "type": "object", "properties": { "access_token": { "type": "string", "nullable": true, "description": "Token which carries the necessary information to access a Twilio resource directly." }, "refresh_token": { "type": "string", "nullable": true, "description": "Token which carries the information necessary to get a new access token." }, "id_token": { "type": "string", "nullable": true, "description": "Token which carries the information necessary of user profile." }, "token_type": { "type": "string", "nullable": true, "description": "Token type" }, "expires_in": { "type": "integer", "format": "int64", "nullable": true } } } } }, "servers": [ { "url": "https://preview-iam.twilio.com" } ] }