FacebookWorkplaceAccountManagement

FREE
By zakutynsky
Updated 5 months ago
Social
-/10
Popularity Score
-
Latency
-
Success Rate

FacebookWorkplaceAccountManagement API Documentation

Managing user accounts and a Graph API for managing groups membership, and content that exists within your instance.

View API Details
POSTcreateAccountForPerson
POSTdeactivateUserAccount
POSTdeletingUserAccount
POSTgetAllUsers
POSTupdateUser
POSTcreateAccountForPerson

When a new person joins your organization or is newly-granted access to Workplace, you must create an account for them

Header Parameters
X-RapidAPI-HostSTRING
REQUIRED
X-RapidAPI-KeySTRING
REQUIRED
Required Parameters
scimIdNUMBER
REQUIREDYour scim company id
nameSTRING
REQUIREDThe components of the Users real name.
userNameSTRING
REQUIREDUnique identifier for the user, used by the user to directly authenticate with the service provider. Must be unique.
accessTokenCREDENTIALS
REQUIREDThe api key obtained from Facebook Workplace
Optional Parameters
emailSTRING
OPTIONALPrimary user e-mail
nickNameSTRING
OPTIONALThe casual way to address the user in real life, e.g., Bob or Bobby instead of Robert. This attribute SHOULD NOT be used to represent a username.
activeSELECT
OPTIONALA Boolean value indicating whether a user is active. Set to true if the user is able to access Workplace and should receive email and mobile push notifications. Set to false to cause the user to be logged out and to prevent the user from receiving further emails or mobile push notifications.
titleSTRING
OPTIONALTitle of the user, e.g., Vice President.
Code Snippet
unirest.post("https://FacebookWorkplaceAccountManagementzakutynskyV1.p.rapidapi.com/createAccountForPerson")
.header("X-RapidAPI-Host", "FacebookWorkplaceAccountManagementzakutynskyV1.p.rapidapi.com")
.header("X-RapidAPI-Key", "SIGN-UP-FOR-KEY")
.header("Content-Type", "application/x-www-form-urlencoded")
.end(function (result) {
  console.log(result.status, result.headers, result.body);
});
Sample Response
General
Request URL: https://FacebookWorkplaceAccountManagementzakutynskyV1.p.rapidapi.com/createAccountForPerson
Request Method: POST
Response Headers
Response Body

Install SDK for NodeJS

Installing

To utilize unirest for node.js install the the npm module:

$ npm install unirest

After installing the npm package you can now start simplifying requests like so:

var unirest = require('unirest');

Creating Request

unirest.post("https://FacebookWorkplaceAccountManagementzakutynskyV1.p.rapidapi.com/createAccountForPerson")
.header("X-RapidAPI-Host", "FacebookWorkplaceAccountManagementzakutynskyV1.p.rapidapi.com")
.header("X-RapidAPI-Key", "SIGN-UP-FOR-KEY")
.header("Content-Type", "application/x-www-form-urlencoded")
.end(function (result) {
  console.log(result.status, result.headers, result.body);
});
OAuth2 Authentication
Client ID
Client Secret
OAuth2 Authentication