Skip to content

Latest commit

 

History

History
117 lines (88 loc) · 4.62 KB

experienceUsers.md

File metadata and controls

117 lines (88 loc) · 4.62 KB

Experience Users Actions

Details on the various actions that can be performed on the Experience Users resource, including the expected parameters and the potential responses.

Contents

Get

Returns the experience users for an application

var params = {
  applicationId: myApplicationId
};

// with callbacks
client.experienceUsers.get(params, function (err, result) {
  if (err) { return console.error(err); }
  console.log(result);
});

// with promises
client.experienceUsers.get(params)
  .then(console.log)
  .catch(console.error);

Authentication

The client must be configured with a valid api access token to call this action. The token must include at least one of the following scopes: all.Application, all.Application.read, all.Organization, all.Organization.read, all.User, all.User.read, experienceUsers.*, or experienceUsers.get.

Available Parameters

Name Type Required Description Default Example
applicationId string Y ID associated with the application 575ec8687ae143cd83dc4a97
sortField string N Field to sort the results by. Accepted values are: firstName, lastName, email, id, creationDate, lastLogin, lastUpdated email email
sortDirection string N Direction to sort the results by. Accepted values are: asc, desc asc asc
page string N Which page of results to return 0 0
perPage string N How many items to return per page 100 10
filterField string N Field to filter the results by. Blank or not provided means no filtering. Accepted values are: firstName, lastName, email email
filter string N Filter to apply against the filtered field. Supports globbing. Blank or not provided means no filtering. my*user
experienceGroupId string N Filter users to those only in the specified group, special experienceGroupIds of 'any' which will give users who are in at least one group and 'none' will give you users who are not in any groups. 575ec8687ae143cd83dc4a97
includeAncestorGroups string N If set will include members from ancestors of the specified experienceGroupId true
query Advanced Experience User Query N Experience user filter JSON object which overrides all other filter params. Advanced Experience User Query Example
losantdomain string N Domain scope of request (rarely needed) example.com

Successful Responses

Code Type Description
200 Experience Users Collection of experience users

Error Responses

Code Type Description
400 Error Error if malformed request
404 Error Error if application was not found

Post

Create a new experience user for an application

var params = {
  applicationId: myApplicationId,
  experienceUser: myExperienceUser
};

// with callbacks
client.experienceUsers.post(params, function (err, result) {
  if (err) { return console.error(err); }
  console.log(result);
});

// with promises
client.experienceUsers.post(params)
  .then(console.log)
  .catch(console.error);

Authentication

The client must be configured with a valid api access token to call this action. The token must include at least one of the following scopes: all.Application, all.Organization, all.User, experienceUsers.*, or experienceUsers.post.

Available Parameters

Name Type Required Description Default Example
applicationId string Y ID associated with the application 575ec8687ae143cd83dc4a97
experienceUser Experience User Post Y New experience user information Experience User Post Example
losantdomain string N Domain scope of request (rarely needed) example.com

Successful Responses

Code Type Description
201 Experience User Successfully created experience user

Error Responses

Code Type Description
400 Error Error if malformed request
404 Error Error if application was not found