Account Management API | Meta for Developers
Admin Center Account Management API Updated : May 5, 2026 Copy for LLM View as Markdown The account management API for Meta Admin Center is a REST-based API that is compliant with the open standard SCIM 2.0 , and which can be used for creating, updating and deactivating accounts within Admin Center. In this section you’ll find documentation for the SCIM schemas supported by Admin Center, as well as example requests and guides for how to use the API.
Using the API The account management API is available to organizations using Admin Center via custom integrations. In order to use the API, you need to have the correct permissions to create and manage custom integrations for your organization on Admin Center. Follow the steps below to use the API: Within Admin Center, navigate to the People panel, then open the Identity providers tab. Click the Connect button, then choose Custom setup to create a new integration for your organization.
Add the name and description as required, and provide a list of IP addresses from which the API calls will be made. On the Permissions tab for your custom integration, add the permission Manage accounts . Get an access token for your custom integration by following the steps in the Permissions and access tokens guide. Make API requests to the API endpoints with the required parameters. Custom integrations are scoped to the Admin Center where they were created.
API Endpoint Base URL The account management API is served from the base URL shown below: https://scim.workplace.com Supported paths Users The Users endpoint path is used to provision and manage accounts for your organization in Admin Center. https://scim.workplace.com/Users This is currently the only accessible endpoint for Work Accounts. All schema and extension properties outlined herein can be used with this endpoint.
Making API requests All API requests must include Authorization and User-Agent headers. Authorization requires a valid access token. To learn more about generating access tokens, see Permissions & access tokens . GET /Users/ HTTP/1.1 Host: scim.workplace.com Authorization: Bearer {your access token} User-Agent: {your user agent} Core User schema URN: urn:ietf:params:scim:schemas:core:2.0:User The core user schema provides the base properties to interface with the SCIM API.
The root schema may be further expanded with the schema extensions found in the subsequent sections of this document. Field Type Description Optionality active Boolean Identifies an account as active or inactive. Active accounts are able to access Meta tools and receive notifications. Optional addresses Object Array Addresses for the account. Optional ↳ country String The country name in accordance with the ISO 3166-1 alpha-2 short code format. ↳ formatted String The full mailing address formatted for display or use with a mailing label.
This field can accept multi-line extended street address information by allowing newlines ( \n ). ↳ locality String The city or locality of the address. ↳ postalCode String The zip code or postal code. ↳ primary Boolean Indicates that this is the account’s primary address. Only one address can be designated as the account’s primary address. ↳ region String The state or region. ↳ streetAddress String The full street address including house/apt number, street name, P.O. box, etc as required.
This field can accept multi-line extended street address information by allowing newlines ( \n .) ↳ type String Identifies the address type in accordance with the organization’s contacts structure, e.g. “Work”, “Personal”. emails Object Array The properties of the account holder’s email address(es). Optional ↳ display String READ ONLY. The standardized representation of the account’s email address. This will be the email address displayed in Meta tools. ↳ primary Boolean Indicates that this is the primary email address for the account.
Only one email address can be designated as the account’s primary email address. ↳ type String Identifies the email type in accordance with the organization’s contacts structure, e.g. “Work”, “Personal”. ↳ value String The complete email address of the account. externalId String A customer-defined identifier for the User. A String that is an identifier for the resource as defined by the provisioning client.
Optional id String READ ONLY. The unique identifier for the account, as generated in Admin Center. Optional locale String Identifies the account holder’s default location for the purposes of localization. The value must be a language tag in accordance with ISO 639-1 and ISO 3166-1. For further details, see W3 language tags . Optional name Object The properties of the account’s name. Optional ↳ familyName String The family name, last name or surname of the account holder. ↳ formatted String The account holder’s complete name, formatted for display including all prefixes, suffixes and middle names as required. ↳ givenName String The given name or first name of the account holder. preferredLanguage String The preferred language for the account holder.
The value must be a language tag in accordance with ISO 639-1 and ISO 3166-1. For further details, see W3 language tags . Optional schemas String Array The URN(s) for the schema. Optional timezone String The timezone of the account. The value must be in accordance with the Olson timezone database format. Optional title String The job title of the account holder. Optional userName String An organization-defined unique identifier for the account.
Required. Must be a primary email address. Required userType String Identifies the account holder’s relationship with their organization. Values should be in accordance with the organization’s employee structure. Optional Extensions Enterprise Extension URN: urn:ietf:params:scim:schemas:extension:enterprise:2.0:User This extension allows organizational properties to be attributed to an account. Fixed Fields Field Type Description employeeNumber String A customer-defined employee identifier for the user. department String Identifies the name of the user’s department. manager Object The properties of the user’s manager.
When removing a user’s manager, the full object must be removed. It cannot contain an empty value. ↳ value String The Admin Center generated unique identifier ( id ) for the manager’s account. ↳ $ref String READ ONLY. The URI of the SCIM resource representing the User’s manager. ↳ displayName String READ ONLY. The display name of the manager. Start/Term Date Extension URN: urn:ietf:params:scim:schemas:extension:facebook:starttermdates:2.0:User The Start/Termination Date Extension is used to store the start and termination dates of a user.
Fixed Fields Field Type Description startDate String The organization’s hire date for the employee. Date format xsd:dateTime (YYYY-MM-DDThh:mm:ssZ) termDate String The organization’s termination date for the employee. Date format xsd:dateTime (YYYY-MM-DDThh:mm:ssZ) Account Status Details Extension URN: urn:ietf:params:scim:schemas:extension:facebook:accountstatusdetails:2.0:User The Account Status Details Extension is used to identify specific states for a user account.
Fixed Fields Field Type Description accessCode String READ ONLY. An access code generated by Admin Center for initial account login. accessCodeExpirationDate Date/Time READ ONLY. The expiration date for the access code. canDelete Boolean READ ONLY. Identifies whether the account can be deleted. claimed Boolean Identifies if the account holder has claimed the account or not. claimDate Date/Time Identifies the date (displayed as a Unix timestamp) when the user claimed the account. claimLink URL The URL that allows a user to claim the account. invited Boolean Identifies if a user is invited to Work Accounts or not. invitedDate Date/Time Identifies the date (displayed as a Unix timestamp) when the invitation was sent.
When executi
The rest of this page is on the live site.