SCIM API Reference
Note: Figma's SCIM API is distinct from the Figma REST API. The SCIM API uses a different base URL, provides a separate set of endpoints, and uses a different method of authentication.
SCIM is an API that Figma supports for managing the creation, updating, and deletion of user accounts. SCIM is not used for authentication, only for user lifecycle management. Read through Figma's SSO guides for more information about authentication. Figma supports dedicated integrations with the following identity providers (IdP) who leverage the SCIM API:
Customers with IdPs outside of those mentioned can still integrate with Figma for user lifecycle management by leveraging our SCIM endpoints.
Note: SCIM is not supported on the Starter or Professional Plan.
The SCIM API is a REST API that can be accessed over HTTP protocol using verbs. GET for retrieving information, POST for creating new objects, PUT for overwriting objects, PATCH for modifying objects, and DELETE to remove objects.
SCIM Prerequisites
To interact with Figma's SCIM API, two pieces of information are required to be generated from Figma Admin Settings by an Organization Administrator.
Generate an API Token
- In the Login and Provisioning section of Admin Settings, click SCIM Provisioning.
- Click Generate Token.
- Copy the API Token value. Note: This will only be shown once, so record it somewhere safe for future reference.
Find your Tenant ID
- In the Login and Provisioning section of Admin Settings, click SAML SSO.
- Copy the Tenant ID. Note: The Tenant ID is required to form the SCIM base URL.
SCIM API Base URL
Use your Tenant ID to construct the base URL for the SCIM API: https://www.figma.com/scim/v2/:tenantid
The API token must be included in an Authorization header using Bearer when calling any of the SCIM methods.
For POST or PUT write operations, provide a JSON request body and set the HTTP Content-type header to application/json.
Example
GET https://www.figma.com/scim/v2/:tenantid/Users
Authorization: "Bearer [Figma API Token]"