Skip to content
This repository was archived by the owner on Jan 12, 2021. It is now read-only.

UsersApi.md

Latest commit

 

History

History
286 lines (208 loc) · 13.7 KB

UsersApi.md

File metadata and controls

286 lines (208 loc) · 13.7 KB

UsersApi

All URIs are relative to http://localhost/

Method HTTP request Description
create POST api/v2/users.json_api Create a(n) User
delete DELETE api/v2/users/{id}.json_api Delete a(n) User
list PUT api/v2/users.json_api Get a list of Users
show GET api/v2/users/{id}.json_api Show a single User
update PATCH api/v2/users/{id}.json_api Update a(n) User

create

User create(email, firstName, lastName, include, accessLevel, disableDailyEmails, phone, roleId, subOrganizationIds, teamIds, timeZone)

Create a(n) User

Example

// Import classes:
//import io.evident.EspSdk.ApiException;
//import io.evident.api.UsersApi;


UsersApi apiInstance = new UsersApi();
String email = "email_example"; // String | The email of the user
String firstName = "firstName_example"; // String | The first name of the user
String lastName = "lastName_example"; // String | The last name of the user
String include = "include_example"; // String | Related objects that can be included in the response:  organization, sub_organizations, teams, role See Including Objects for more information.
String accessLevel = "accessLevel_example"; // String | The level of access this user has. Team access has access to items belonging only to that team. Sub Organization access has access to items belonging only to all teams under that sub organization. Organization access has access to all sub organizations and teams under that organization. Valid values are organization_level, sub_organization_level, team_level
Boolean disableDailyEmails = true; // Boolean | Specifies whether the daily emails should be turned off or not
String phone = "phone_example"; // String | The phone number of the user
Integer roleId = 56; // Integer | The ID of the role of the user. Only a manager can set or modify the role id.
List<Integer> subOrganizationIds = Arrays.asList(56); // List<Integer> | A list of sub organization IDs that the user should have access to. Only a manager can set or modify the sub organization ids.
List<Integer> teamIds = Arrays.asList(56); // List<Integer> | A list of team IDs that the user should have access to. Only a manager can set or modify the team ids.
String timeZone = "timeZone_example"; // String | The time zone of the user. See Time Zones for a list of valid time zones
try {
    User result = apiInstance.create(email, firstName, lastName, include, accessLevel, disableDailyEmails, phone, roleId, subOrganizationIds, teamIds, timeZone);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling UsersApi#create");
    e.printStackTrace();
}

Parameters

Name Type Description Notes
email String The email of the user
firstName String The first name of the user
lastName String The last name of the user
include String Related objects that can be included in the response: organization, sub_organizations, teams, role See Including Objects for more information. [optional]
accessLevel String The level of access this user has. Team access has access to items belonging only to that team. Sub Organization access has access to items belonging only to all teams under that sub organization. Organization access has access to all sub organizations and teams under that organization. Valid values are organization_level, sub_organization_level, team_level [optional] [enum: organization_level, sub_organization_level, team_level]
disableDailyEmails Boolean Specifies whether the daily emails should be turned off or not [optional]
phone String The phone number of the user [optional]
roleId Integer The ID of the role of the user. Only a manager can set or modify the role id. [optional]
subOrganizationIds List<Integer> A list of sub organization IDs that the user should have access to. Only a manager can set or modify the sub organization ids. [optional]
teamIds List<Integer> A list of team IDs that the user should have access to. Only a manager can set or modify the team ids. [optional]
timeZone String The time zone of the user. See Time Zones for a list of valid time zones [optional]

Return type

User

Authorization

No authorization required

HTTP request headers

  • Content-Type: application/vnd.api+json
  • Accept: application/vnd.api+json

delete

Meta delete(id, currentPassword)

Delete a(n) User

The users current password is required when deleting yourself.

Example

// Import classes:
//import io.evident.EspSdk.ApiException;
//import io.evident.api.UsersApi;


UsersApi apiInstance = new UsersApi();
Integer id = 56; // Integer | User ID
String currentPassword = "currentPassword_example"; // String | The user's currently stored password
try {
    Meta result = apiInstance.delete(id, currentPassword);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling UsersApi#delete");
    e.printStackTrace();
}

Parameters

Name Type Description Notes
id Integer User ID
currentPassword String The user's currently stored password [optional]

Return type

Meta

Authorization

No authorization required

HTTP request headers

  • Content-Type: application/vnd.api+json
  • Accept: application/vnd.api+json

list

PaginatedCollection list(include, filter, page)

Get a list of Users

Example

// Import classes:
//import io.evident.EspSdk.ApiException;
//import io.evident.api.UsersApi;


UsersApi apiInstance = new UsersApi();
String include = "include_example"; // String | Related objects that can be included in the response:  organization, sub_organizations, teams, role See Including Objects for more information.
Map<String, String> filter = new HashMap(); // Map<String, String> | Filter Params for Searching.  Equality Searchable Attributes: [id, email] Matching Searchable Attribute: [email]  Sortable Attributes: [email, current_sign_in_at, updated_at, created_at, id] Searchable Associations: [role, organization, sub_organizations, teams] See Searching Lists for more information. See the filter parameter of the association's list action to see what attributes are searchable on each association. See Conditions on Relationships in Searching Lists for more information.
String page = "{:number=>1,+:size=>20}"; // String | Page Number and Page Size.  Number is the page number of the collection to return, size is the number of items to return per page.
try {
    PaginatedCollection result = apiInstance.list(include, filter, page);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling UsersApi#list");
    e.printStackTrace();
}

Parameters

Name Type Description Notes
include String Related objects that can be included in the response: organization, sub_organizations, teams, role See Including Objects for more information. [optional]
filter Map<String, String> Filter Params for Searching. Equality Searchable Attributes: [id, email] Matching Searchable Attribute: [email] Sortable Attributes: [email, current_sign_in_at, updated_at, created_at, id] Searchable Associations: [role, organization, sub_organizations, teams] See Searching Lists for more information. See the filter parameter of the association's list action to see what attributes are searchable on each association. See Conditions on Relationships in Searching Lists for more information. [optional]
page String Page Number and Page Size. Number is the page number of the collection to return, size is the number of items to return per page. [optional] [default to {:number=>1,+:size=>20}]

Return type

PaginatedCollection

Authorization

No authorization required

HTTP request headers

  • Content-Type: application/vnd.api+json
  • Accept: application/vnd.api+json

show

User show(id, include)

Show a single User

Example

// Import classes:
//import io.evident.EspSdk.ApiException;
//import io.evident.api.UsersApi;


UsersApi apiInstance = new UsersApi();
Integer id = 56; // Integer | User ID
String include = "include_example"; // String | Related objects that can be included in the response:  organization, sub_organizations, teams, role See Including Objects for more information.
try {
    User result = apiInstance.show(id, include);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling UsersApi#show");
    e.printStackTrace();
}

Parameters

Name Type Description Notes
id Integer User ID
include String Related objects that can be included in the response: organization, sub_organizations, teams, role See Including Objects for more information. [optional]

Return type

User

Authorization

No authorization required

HTTP request headers

  • Content-Type: application/vnd.api+json
  • Accept: application/vnd.api+json

update

User update(id, include, accessLevel, disableDailyEmails, firstName, lastName, phone, roleId, subOrganizationIds, teamIds, timeZone)

Update a(n) User

Example

// Import classes:
//import io.evident.EspSdk.ApiException;
//import io.evident.api.UsersApi;


UsersApi apiInstance = new UsersApi();
Integer id = 56; // Integer | User ID
String include = "include_example"; // String | Related objects that can be included in the response:  organization, sub_organizations, teams, role See Including Objects for more information.
String accessLevel = "accessLevel_example"; // String | The level of access this user has. Team access has access to items belonging only to that team. Sub Organization access has access to items belonging only to all teams under that sub organization. Organization access has access to all sub organizations and teams under that organization. Valid values are organization_level, sub_organization_level, team_level
Boolean disableDailyEmails = true; // Boolean | Specifies whether the daily emails should be turned off or not
String firstName = "firstName_example"; // String | The first name of the user
String lastName = "lastName_example"; // String | The last name of the user
String phone = "phone_example"; // String | The phone number of the user
Integer roleId = 56; // Integer | The ID of the role of the user. Only a manager can set or modify the role id.
List<Integer> subOrganizationIds = Arrays.asList(56); // List<Integer> | A list of sub organization IDs that the user should have access to. Only a manager can set or modify the sub organization ids.
List<Integer> teamIds = Arrays.asList(56); // List<Integer> | A list of team IDs that the user should have access to. Only a manager can set or modify the team ids.
String timeZone = "timeZone_example"; // String | The time zone of the user. See Time Zones for a list of valid time zones
try {
    User result = apiInstance.update(id, include, accessLevel, disableDailyEmails, firstName, lastName, phone, roleId, subOrganizationIds, teamIds, timeZone);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling UsersApi#update");
    e.printStackTrace();
}

Parameters

Name Type Description Notes
id Integer User ID
include String Related objects that can be included in the response: organization, sub_organizations, teams, role See Including Objects for more information. [optional]
accessLevel String The level of access this user has. Team access has access to items belonging only to that team. Sub Organization access has access to items belonging only to all teams under that sub organization. Organization access has access to all sub organizations and teams under that organization. Valid values are organization_level, sub_organization_level, team_level [optional] [enum: organization_level, sub_organization_level, team_level]
disableDailyEmails Boolean Specifies whether the daily emails should be turned off or not [optional]
firstName String The first name of the user [optional]
lastName String The last name of the user [optional]
phone String The phone number of the user [optional]
roleId Integer The ID of the role of the user. Only a manager can set or modify the role id. [optional]
subOrganizationIds List<Integer> A list of sub organization IDs that the user should have access to. Only a manager can set or modify the sub organization ids. [optional]
teamIds List<Integer> A list of team IDs that the user should have access to. Only a manager can set or modify the team ids. [optional]
timeZone String The time zone of the user. See Time Zones for a list of valid time zones [optional]

Return type

User

Authorization

No authorization required

HTTP request headers

  • Content-Type: application/vnd.api+json
  • Accept: application/vnd.api+json