Graph API Version

System User

Reading

Represents a system user

Example

Graph API Explorer
GET /v4.0/{system-user-id} HTTP/1.1
Host: graph.facebook.com
/* PHP SDK v5.0.0 */
/* make the API call */
try {
  // Returns a `Facebook\FacebookResponse` object
  $response = $fb->get(
    '/{system-user-id}',
    '{access-token}'
  );
} catch(Facebook\Exceptions\FacebookResponseException $e) {
  echo 'Graph returned an error: ' . $e->getMessage();
  exit;
} catch(Facebook\Exceptions\FacebookSDKException $e) {
  echo 'Facebook SDK returned an error: ' . $e->getMessage();
  exit;
}
$graphNode = $response->getGraphNode();
/* handle the result */
/* make the API call */
FB.api(
    "/{system-user-id}",
    function (response) {
      if (response && !response.error) {
        /* handle the result */
      }
    }
);
/* make the API call */
new GraphRequest(
    AccessToken.getCurrentAccessToken(),
    "/{system-user-id}",
    null,
    HttpMethod.GET,
    new GraphRequest.Callback() {
        public void onCompleted(GraphResponse response) {
            /* handle the result */
        }
    }
).executeAsync();
// For more complex open graph stories, use `FBSDKShareAPI`
// with `FBSDKShareOpenGraphContent`
/* make the API call */
FBSDKGraphRequest *request = [[FBSDKGraphRequest alloc]
                               initWithGraphPath:@"/{system-user-id}"
                                      parameters:params
                                      HTTPMethod:@"GET"];
[request startWithCompletionHandler:^(FBSDKGraphRequestConnection *connection,
                                      id result,
                                      NSError *error) {
    // Handle the result
}];
If you want to learn how to use the Graph API, read our Using Graph API guide.

Parameters

This endpoint doesn't have any parameters.

Fields

FieldDescription
id
numeric string

System user ID.

created_by

The creator of this system user.

created_time
datetime

The creation time of this system user.

finance_permission
string

Financial permission role of the user in business manager, such as Editor, Analyst, and so on.

ip_permission
string

Ads right permission role of the user in business manager, such as Reviewer, and so on.

name
string

Name used to identify this system user.

Edges

EdgeDescription

Ad accounts that are assigned to this business scoped user

Business asset groups that are assign to this business scoped user

Pages that are assigned to this business scoped user

Product catalogs that are assigned to this business scoped user

Person who updated this system user.

Validation Rules

ErrorDescription
100Invalid parameter
110Invalid user id

Creating

You can make a POST request to system_users edge from the following paths:
When posting to this edge, a SystemUser will be created.

Parameters

ParameterDescription
name
string

Name of system user to be added to this business.

Required
role
enum {FINANCE_EDITOR, FINANCE_ANALYST, ADS_RIGHTS_REVIEWER, ADMIN, EMPLOYEE}

Role of system user to be added to this business.

system_user_id
int

ID of system user.

Return Type

This endpoint supports read-after-write and will read the node represented by id in the return type.
Struct {
id: numeric string,
}

Validation Rules

ErrorDescription
3949This Business Manager has reached maximum number of system user limit.
3965This Business Manager has reached maximum number of admin system user limit.
3972System users can not have duplicate names. Use another name.
100Invalid parameter
3951There was an error while creating this system user. Check the parameters and syntax.

Updating

You can't perform this operation on this endpoint.

Deleting

You can't perform this operation on this endpoint.