Health

APIDescription
GET Health/Status

No documentation available.

Customers

Provides methods for working with Customers

APIDescription
GET Customers/{customerID}/Exists

Determines whether or not a Customer exists

GET Customers?includeDisabled={includeDisabled}

Gets all Companies in the system

GET Customers/Extended?includeDisabled={includeDisabled}

Gets all Companies in the system, with optional extended information

GET Customers/{customerID}?includeChildCustomers={includeChildCustomers}

Gets a Customer by id

GET Customers/{customerID}/Extended?includeChildCustomers={includeChildCustomers}

Gets a Customer with optional extended information by id

GET Customers/ByParent/{parentCustomerID}

Gets a Customer by parent Customer id

GET Customers/ByParent/{parentCustomerID}/Extended

Gets a Customer with optional extended information by parent Customer id

POST Customers

Creates a new Customer

POST Customers/Extended

Creates a new Customer

PUT Customers

Updates a Customer

PUT Customers/Extended

Updates a Customer

POST Customers/{customerID}/Properties

Adds or updates properties associated to a Customer

GET Customers/{customerID}/Properties

Get the properties associated with a Customer

DELETE Customers/{customerID}/Properties

Deletes properties from a Customer

GET {authenticationKey}/{version}/Customers/HeartBeat

No documentation available.

Authentication

APIDescription
POST Authentication/ChangePassword

Changes the current users password in the system, and returns a new login token

POST {authenticationKey}/{version}/Authentication/ChangePassword

Changes the current users password in the system, and returns a new login token

POST Authentication/Login

Method to allow the authentication of a user.

POST {authenticationKey}/{version}/Authentication/Login

Method to allow the authentication of a user.

POST Authentication/Logout

Will invalidate the current login token for the current user.

POST {authenticationKey}/{version}/Authentication/Logout

Will invalidate the current login token for the current user.

GET Authentication/IsTokenValid?authToken={authToken}&gracePeriodMinutes={gracePeriodMinutes}

Returns true if the authentication token is valid, false otherwise

GET {authenticationKey}/{version}/Authentication/IsTokenValid?authToken={authToken}&gracePeriodMinutes={gracePeriodMinutes}

Returns true if the authentication token is valid, false otherwise

GET {authenticationKey}/{version}/Authentication/HeartBeat

No documentation available.

Roles

Provides an interface for common user role management.

APIDescription
POST Roles/{userPublicKey}/Assign

Assigns roles to a user

POST {authenticationKey}/{version}/Roles/{userPublicKey}/Assign

Assigns roles to a user

POST Roles/{userPublicKey}/Remove

Remove roles from a user

POST {authenticationKey}/{version}/Roles/{userPublicKey}/Remove

Remove roles from a user

POST Roles/{roleName}/Permissions/Assign

Assigns Permissions to a role

POST Roles/Permissions/Assign?roleName={roleName}

Assigns Permissions to a role

POST {authenticationKey}/{version}/Roles/{roleName}/Permissions/Assign

Assigns Permissions to a role

DELETE Roles/{roleName}/Permissions/Remove

Removes Permissions from a role

DELETE Roles/Permissions/Remove?roleName={roleName}

Removes Permissions from a role

DELETE {authenticationKey}/{version}/Roles/{roleName}/Permissions/Remove

Removes Permissions from a role

GET Roles/{roleName}

Gets a role and all its associated permissions.

GET {authenticationKey}/{version}/Roles/{roleName}

Gets a role and all its associated permissions.

POST Roles

Gets a collection of roles and all their associated permissions.

POST {authenticationKey}/{version}/Roles

Gets a collection of roles and all their associated permissions.

GET Roles?moduleKey={moduleKey}

Gets all roles for an System Entity module.

GET {authenticationKey}/{version}/Roles?moduleKey={moduleKey}

Gets all roles for an System Entity module.

GET Roles/All

Gets all Roles.

GET {authenticationKey}/{version}/Roles/All

Gets all Roles.

GET Roles/{roleName}/Users

Gets back users that belong to the specified role.

GET Roles/Users?roleName={roleName}

Gets back users that belong to the specified role.

POST Roles/Users

Gets back users based on a collection of role names

POST {authenticationKey}/{version}/Roles/Users

Gets back users based on a collection of role names

PUT Roles/RefreshCache?resetDelta={resetDelta}

Refreshes Roles cache.

PUT {authenticationKey}/{version}/Roles/RefreshCache?resetDelta={resetDelta}

Refreshes Roles cache.

GET {authenticationKey}/{version}/Roles/HeartBeat

No documentation available.

Accounts

Provides an interface for common user authentication operations, as well as administrative tasks for users.

APIDescription
POST Accounts

Will create a new user in the system If a user already exists, the system will return status code 200 with a message stating that the user already exists.

POST {authenticationKey}/{version}/Accounts

Will create a new user in the system If a user already exists, the system will return status code 200 with a message stating that the user already exists.

DELETE Accounts/{userPublicKey}

Will soft-delete a user from the system.

DELETE {authenticationKey}/{version}/Accounts/{userPublicKey}

Will soft-delete a user from the system.

PUT Accounts/{userPublicKey}

Updates the user account.

PUT {authenticationKey}/{version}/Accounts/{userPublicKey}

Updates the user account.

POST Accounts/ForgotPassword?userNameOrEmail={userNameOrEmail}&tokenDurationHours={tokenDurationHours}

Returns a token that can be used to reset a users password.

POST {authenticationKey}/{version}/Accounts/ForgotPassword?userNameOrEmail={userNameOrEmail}&tokenDurationHours={tokenDurationHours}

Returns a token that can be used to reset a users password.

GET Accounts/GetUserByResetToken?passwordResetToken={passwordResetToken}

Gets user details by token

GET {authenticationKey}/{version}/Accounts/GetUserByResetToken?passwordResetToken={passwordResetToken}

Gets user details by token

POST Accounts/ResetPassword

reset the password of the member using email

POST {authenticationKey}/{version}/Accounts/ResetPassword

reset the password of the member using email

GET Accounts/{userNameOrEmail}/exists

Checks to see if the given username or email address exists in the system

GET {authenticationKey}/{version}/Accounts/{userNameOrEmail}/exists

Checks to see if the given username or email address exists in the system

GET Accounts

Gets all users for the current System Entity.

GET {authenticationKey}/{version}/Accounts

Gets all users for the current System Entity.

GET Accounts/ByCustomer/{customerID}

Gets all users associated with the customer id

GET Accounts?userName={userName}

Gets back a user based on username

GET {authenticationKey}/{version}/Accounts?userName={userName}

Gets back a user based on username

GET Accounts/Search?username={username}

Gets back a user based on username

GET {authenticationKey}/{version}/Accounts/Search?username={username}

Gets back a user based on username

GET Accounts/Search/Email?email={email}

Gets back a user based on email address

GET {authenticationKey}/{version}/Accounts/Search/Email?email={email}

Gets back a user based on email address

GET Accounts/FromAuthToken

Gets back a user based on their current Auth Token.

GET {authenticationKey}/{version}/Accounts/FromAuthToken

Gets back a user based on their current Auth Token.

POST Accounts/ByKeys

Gets back users based on their public key

POST {authenticationKey}/{version}/Accounts/ByKeys

Gets back users based on their public key

POST Accounts/UserIDCollection

Gets back users based on their ID

POST {authenticationKey}/{version}/Accounts/ByIds

Gets back users based on their UniqueID

POST Accounts/GetEffectiveRoles

Gets back the effective permissions for a collection of users.

POST {authenticationKey}/{version}/Accounts/GetEffectiveRoles

Gets back the effective permissions for a collection of users.

POST Accounts/{moduleKey}/GetEffectiveRoles

Gets back the effective permissions for a given module for a collection of users.

POST {authenticationKey}/{version}/Accounts/{moduleKey}/GetEffectiveRoles

Gets back the effective permissions for a given module for a collection of users.

GET Accounts/{userPublicKey}/EffectivePermissions

Gets back a user's effective permissions.

GET {authenticationKey}/{version}/Accounts/{userPublicKey}/EffectivePermissions

Gets back a user's effective permissions.

POST Accounts/EffectivePermissions

Gets back the effective permissions for a collection of users.

POST {authenticationKey}/{version}/Accounts/EffectivePermissions

Gets back the effective permissions for a collection of users.

POST Accounts/{userPublicKey}/Properties

Adds or updates properties to/for the given User

GET Accounts/{userPublicKey}/Properties

Gets all properties for the given User

DELETE Accounts/{userPublicKey}/Properties

Deletes specific properties for the given User

POST Accounts/Search

Finds Users by properties

PUT Accounts/RefreshCache?resetDelta={resetDelta}

Will reload the system entity cache, including module connection information.

PUT {authenticationKey}/{version}/Accounts/RefreshCache?resetDelta={resetDelta}

Will reload the system entity cache, including module connection information.

GET {authenticationKey}/{version}/Accounts/HeartBeat

No documentation available.

Permissions

Provides an interface for common user permission management.

APIDescription
POST Permissions/{userPublicKey}/Assign

Assigns permissions to a given user.

POST {authenticationKey}/{version}/Permissions/{userPublicKey}/Assign

Assigns permissions to a given user.

POST Permissions

Allows an Entity Admin to create custom permissions to be used by their application. These permissions are entirely for the client side benefit and are not enforceable by this API.

POST {authenticationKey}/{version}/Permissions

Allows an Entity Admin to create custom permissions to be used by their application. These permissions are entirely for the client side benefit and are not enforceable by this API.

GET Permissions

Gets all permissions for the current System Entity

GET {authenticationKey}/{version}/Permissions

Gets all permissions for the current System Entity

GET Permissions/IsAuthorized?systemModuleKey={systemModuleKey}&allowedPermission={allowedPermission}

Checks to see if a user is authorized for a specific method or not.

GET {authenticationKey}/{version}/Permissions/IsAuthorized?systemModuleKey={systemModuleKey}&allowedPermission={allowedPermission}

Checks to see if a user is authorized for a specific method or not.

PUT Permissions/RefreshCache?resetDelta={resetDelta}

Refreshes Permission cache.

PUT {authenticationKey}/{version}/Permissions/RefreshCache?resetDelta={resetDelta}

Refreshes Permission cache.

GET {authenticationKey}/{version}/Permissions/HeartBeat

No documentation available.