Auth V2
This guide is targeted at developers with experience in using REST APIs to orchestrate integrations between multiple real-time systems. It is expected that the developer is versed in using APIs in a low-latency mode, to reduce negative impact to the handling of voice calls, emails, chats or other sessions that are active.
The Platform28 Cloud API can be used to create, modify and delete most entities within Platform28. In addition, the API can be used to actuate real-time control of :term:sessions that are in progress, or to initiate new sessions. There are a few exceptional cases where a session may be initiated after-the-fact by an API request.
The API is accessed via REST and most message contents are JSON. There are a few exceptions where FORM posts are accepted, such as in the case of file-uploads. Most API’s use matrix-parameters (within the URL), while newer API’s have moved to the more common query parameter model.
This is a test chapter This is a test chapter This is a test chapter This is a test chapter This is a test chapter This is a test chapter This is a test chapter This is a test chapter This is a test chapter This is a test chapter This is a test chapter This is a test chapter This is a test chapter This is a test chapter This is a test chapter This is a test chapter This is a test chapter This is a test chapter This is a test chapter This is a test chapter This is a test chapter This is a test chapter This is a test chapter This is a test chapter This is a test chapter This is a test chapter This is a test chapter This is a test chapter This is a test chapter This is a test chapter This is a test chapter This is a test chapter
Ex1
{
"object": 1,
"name":"renny"
}Ex2
import blah;
blah.sendData();Most API requests require an API Key or an active Login Session ID (LSID) to be provided with the request. LSIDs are included as matrix parameters in the query, while API Keys are included as query_parameters. If you do not already have an API key, and wish to integrate an application or backend service, please contact the Platform28 Support team.
LSID’s must be used in cases where your code is acting on behalf of a logged-in user, while API Keys are used when acting on behalf of the system that is being integrated.
{username}{username}{username}{username}Path variables
Request body
Responses
successful operation
curl -X GET "/authenticate/block/test" \
-H "Content-Type: application/x-www-form-urlencoded"Client.initiateRequest("blah");{sessionId}{sessionId}{sessionId}/setEffectiveUser{sessionId}/assumedIdentity{sessionId}/setEffectiveOrg{userId}{sessionId}/clone{sessionId}Path variables
Session id to retrieve
Responses
Login session found
Specified session does not exist or the current user does not have access to it
Server error while trying to access the session
{sessionId}slakdl;sak;dlska asdasldk askd
Path variables
Login session id to terminate
Request body
Should all sessions of this user be terminated?
Responses
Login session terminated
Couldn’t find the specified login session
Server error while trying to terminate the session
DELETE /session/123123213213123 HTTP/1.1
Content-Type: application/json
truecurl -X DELETE "/session/12312323" \
-H "Content-Type: application/json1" \
-d 'true'var sessionId = "12312312323213":
SessionAPI.deleteSession(sessionId);{sessionId}/setEffectiveUserPath variables
Session id to update
Request body
User ID to set as the effective user
Responses
Login session updated
Invalid request in POST body
Specified session or user does not exist or the current user does not have access to it
Server error while trying to access the session
{sessionId}/assumedIdentityPath variables
Session id to update
Responses
Login session reset successfully
Specified session does not exist or the current user does not have access to it
Server error while trying to access the session
{sessionId}/setEffectiveOrgPath variables
Session id to update
Request body
Responses
Login session updated
Invalid request in POST body
Specified session or organization does not exist or the current user does not have access to it
Server error while trying to access the session
{userId}Path variables
User id of the user who’s sessions should be terminated
Responses
Login session terminated
Current user is not authorized to logout other users
Couldn’t find the specified user
Server error while trying to terminate the session
{sessionId}/clonePath variables
Session id to update
Responses
Login session created
Specified session does not exist or the current user does not have access to it
Server error while trying to access the session
{userId}Request body
ID of the user to reset
Email address of the user
Phone number of the user - for additional validation
Mobile number of the user - for additional validation
Template name
Reset page URL to use in the email
Responses
successful operation
Request body
Password reset token being used
Username of this account
New password hash of the user
Responses
successful operation
{userId}Update the password of the user based on the specified id and password.
Path variables
ID of desired user
Request body
old password hash of the user
New password hash of the user
Password hash of the admin who is trying to force a password change
Responses
The current login session is invalid
A user with the given ID and Password was not found
Password updated