User and Profiles

Gets a Specific User

Gets a specific user by email or unique user ID.

GEThttp://localhost:8080/api/rest/user/{name}

Path parameters

name*any

Response

400401403404409500501503default

Body

application/json

codestring

A machine readable code of the error.

messagestring

A description of the error. This error is not intended to be displayed to the end-user, rather it is it designed to relay information to the application developer.

Request

JavaScriptCurlPython

const response = await fetch('http://localhost:8080/api/rest/user/{name}', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

400401403404409500501503default

{
  "code": "text",
  "message": "text"
}

Deletes a User

Deletes and permanently removes the user from the server. The server may keep some metadata as necessary to avoid data inconsistency. However, the user has been deleted from the client standpoint and will not be accessible through any of the existing APIs.

DELETEhttp://localhost:8080/api/rest/user/{name}

Path parameters

name*any

Response

400401403404409500501503default

Body

application/json

codestring

A machine readable code of the error.

messagestring

A description of the error. This error is not intended to be displayed to the end-user, rather it is it designed to relay information to the application developer.

Request

JavaScriptCurlPython

const response = await fetch('http://localhost:8080/api/rest/user/{name}', {
    method: 'DELETE',
    headers: {},
});
const data = await response.json();

Response

400401403404409500501503

{
  "code": "text",
  "message": "text"
}

Updates a User's Password

Supplying the UserUpdatePasswordRequest, this will attempt to update the user's password only if they supply the correct existing password.

PUThttp://localhost:8080/api/rest/user/{userId}/password

Path parameters

userId*any

Body

*/*

oldPassword*any

The user's current password.

newPassword*any

The user's updated password.

profileIdany

The user's profile id to assign the new session. Leave blank for no profile id.

Response

400401403404409500501503default

Body

application/json

codestring

A machine readable code of the error.

messagestring

A description of the error. This error is not intended to be displayed to the end-user, rather it is it designed to relay information to the application developer.

Request

JavaScriptCurlPython

const response = await fetch('http://localhost:8080/api/rest/user/{userId}/password', {
    method: 'PUT',
    headers: {
      "Content-Type": "*/*"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

400401403404409500501503default

{
  "code": "text",
  "message": "text"
}

Updates a User

Supplying the user object, this will update the user with the new information supplied in the body of the request. Optionally, the user's password may be provided in the User object.

PUThttp://localhost:8080/api/rest/user/{userId}

Path parameters

userId*any

Body

*/*

name*any

Pattern: ^\S+$

email*any

Pattern: ^(.+)@(.+)$

primaryPhoneNbany

Pattern: ([\.\+\-\s\/()]*[0-9][\.\+\-\s\/()]*){8,15}

firstNameany

Pattern: ^[A-Za-z0-9 ]{2,20}

lastNameany

Pattern: ^[A-Za-z0-9 ]{3,30}

passwordany

The user's plaintext password, only to be provided in POST/PUT requests in the User Resource REST API interface. In the future, a dedicated REST API model may be constructed instead of using a direct User model.

Pattern: ^\S+$

level*enum

UNPRIVILEGEDUSERSUPERUSER

Response

400401403404409500501503default

Body

application/json

codestring

A machine readable code of the error.

messagestring

A description of the error. This error is not intended to be displayed to the end-user, rather it is it designed to relay information to the application developer.

Request

JavaScriptCurlPython

const response = await fetch('http://localhost:8080/api/rest/user/{userId}', {
    method: 'PUT',
    headers: {
      "Content-Type": "*/*"
    },
    body: JSON.stringify({
      "level": "UNPRIVILEGED"
    }),
});
const data = await response.json();

Response

400401403404409500501503default

{
  "code": "text",
  "message": "text"
}

Gets the current User

A special endpoint used to get the current user for the request. The current user is typically associated with the session but may be derived any other way. This is essentially an alias for using GET /user/myUserId

GEThttp://localhost:8080/api/rest/user/me

Response

400401403404409500501503default

Body

application/json

codestring

A machine readable code of the error.

messagestring

A description of the error. This error is not intended to be displayed to the end-user, rather it is it designed to relay information to the application developer.

Request

JavaScriptCurlPython

const response = await fetch('http://localhost:8080/api/rest/user/me', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

400401403404409500501503default

{
  "code": "text",
  "message": "text"
}

Creates a User

Supplying the user object, this will update the user with the new information supplied in the body of the request. Optionally, the user's password may be provided in the User object.

POSThttp://localhost:8080/api/rest/user

Body

*/*

nameany

Pattern: ^\S+$

emailany

Pattern: ^(.+)@(.+)$

primaryPhoneNbany

Pattern: ([\.\+\-\s\/()]*[0-9][\.\+\-\s\/()]*){8,15}

firstNameany

Pattern: ^[A-Za-z0-9 ]{2,20}

lastNameany

Pattern: ^[A-Za-z0-9 ]{3,30}

passwordany

The user's plaintext password, only to be provided in POST/PUT requests in the User Resource REST API interface. In the future, a dedicated REST API model may be constructed instead of using a direct User model.

Pattern: ^\S+$

levelenum

The user's level to assign. Depending on the usage, the server may ignore this field and assign its own description.

UNPRIVILEGEDUSERSUPERUSER

profilesany

A list of profiles to assign to this user during creation. The server will attempt to create a profile for each item in this list.

Response

400401403404409500501503default

Body

application/json

codestring

A machine readable code of the error.

messagestring

A description of the error. This error is not intended to be displayed to the end-user, rather it is it designed to relay information to the application developer.

Request

JavaScriptCurlPython

const response = await fetch('http://localhost:8080/api/rest/user', {
    method: 'POST',
    headers: {
      "Content-Type": "*/*"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

400401403404409500501503default

{
  "code": "text",
  "message": "text"
}

Search Users

Searches all users in the system and returning the metadata for all matches against the given search filter.

GEThttp://localhost:8080/api/rest/user

Query parameters

Response

400401403404409500501503default

Body

application/json

codestring

A machine readable code of the error.

messagestring

A description of the error. This error is not intended to be displayed to the end-user, rather it is it designed to relay information to the application developer.

Request

JavaScriptCurlPython

const response = await fetch('http://localhost:8080/api/rest/user', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

400401403404409500501503default

{
  "code": "text",
  "message": "text"
}

Sign Up a User

Supplying the user create request object, this will create a new user.

POSThttp://localhost:8080/api/rest/signup

Body

*/*

nameany

Pattern: ^\S+$

emailany

Pattern: ^(.+)@(.+)$

primaryPhoneNbany

Pattern: ([\.\+\-\s\/()]*[0-9][\.\+\-\s\/()]*){8,15}

firstNameany

Pattern: ^[A-Za-z0-9 ]{2,20}

lastNameany

Pattern: ^[A-Za-z0-9 ]{3,30}

passwordany

The user's plaintext password, only to be provided in POST/PUT requests in the User Resource REST API interface. In the future, a dedicated REST API model may be constructed instead of using a direct User model.

Pattern: ^\S+$

levelenum

The user's level to assign. Depending on the usage, the server may ignore this field and assign its own description.

UNPRIVILEGEDUSERSUPERUSER

profilesany

A list of profiles to assign to this user during creation. The server will attempt to create a profile for each item in this list.

Response

400401403404409500501503default

Body

application/json

codestring

A machine readable code of the error.

messagestring

A description of the error. This error is not intended to be displayed to the end-user, rather it is it designed to relay information to the application developer.

Request

JavaScriptCurlPython

const response = await fetch('http://localhost:8080/api/rest/signup', {
    method: 'POST',
    headers: {
      "Content-Type": "*/*"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

400401403404409500501503default

{
  "code": "text",
  "message": "text"
}

Destroys the Session

DELETEhttp://localhost:8080/api/rest/session

Response

400401403404409500501503default

Body

application/json

codestring

A machine readable code of the error.

messagestring

A description of the error. This error is not intended to be displayed to the end-user, rather it is it designed to relay information to the application developer.

Request

JavaScriptCurlPython

const response = await fetch('http://localhost:8080/api/rest/session', {
    method: 'DELETE',
    headers: {},
});
const data = await response.json();

Response

400401403404409500501503

{
  "code": "text",
  "message": "text"
}

Creates a Session

Begins a session by accepting both the UserID and the Passoword. Upon successful completion of this call, the user will be added to the current HTTP session. If the session expires, the user will have to reestablish the session by supplying credentials again. This is most useful for applications delivered in a web page.

POSThttp://localhost:8080/api/rest/session

Body

application/json

userId*any

The user ID.

password*any

The password.

profileIdany

The profile ID to assign to the session.

profileSelectorany

A query string to select the profile to use.

Response

400401403404409500501503default

Body

application/json

codestring

A machine readable code of the error.

messagestring

A description of the error. This error is not intended to be displayed to the end-user, rather it is it designed to relay information to the application developer.

Request

JavaScriptCurlPython

const response = await fetch('http://localhost:8080/api/rest/session', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

400401403404409500501503default

{
  "code": "text",
  "message": "text"
}

Destroys the Session

DELETEhttp://localhost:8080/api/rest/session/{sessionSecret}

Path parameters

sessionSecret*any

Response

400401403404409500501503default

Body

application/json

codestring

A machine readable code of the error.

messagestring

A description of the error. This error is not intended to be displayed to the end-user, rather it is it designed to relay information to the application developer.

Request

JavaScriptCurlPython

const response = await fetch('http://localhost:8080/api/rest/session/{sessionSecret}', {
    method: 'DELETE',
    headers: {},
});
const data = await response.json();

Response

400401403404409500501503

{
  "code": "text",
  "message": "text"
}

Creates a Session using Google Sign-In

Begins a session by accepting an auth code and identity token. Upon successful validation against Google's sign-in APIs, this will return a Session which can be used for authentication. If there isno User associated with the supplied credentials, this will implicitly create a new account and will include that account information in the response. If there is an account, or this method receives an existing session key, this will link the existing account to google if the account was not previously linked.

POSThttp://localhost:8080/api/rest/googlesignin_session

Body

application/json

applicationNameOrId*any

identityToken*any

Response

400401403404409500501503default

Body

application/json

codestring

A machine readable code of the error.

messagestring

A description of the error. This error is not intended to be displayed to the end-user, rather it is it designed to relay information to the application developer.

Request

JavaScriptCurlPython

const response = await fetch('http://localhost:8080/api/rest/googlesignin_session', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

400401403404409500501503default

{
  "code": "text",
  "message": "text"
}

Creates a Session using Firebase

Begins a session using Firebase login. Unlike other auth methods, which require the client specify the profile and name, this uses the supplied JWT token. Embedded in the JWT is the identifier for the application. Therefore, Elements will use Firebase's server-to-server APIs in order determine the application configuration to use. Just like other session APIs, if the session specifies a user, then this will link the existing account to the supplied firebase ID.

POSThttp://localhost:8080/api/rest/firebase_session

Body

application/json

firebaseJWT*any

Response

400401403404409500501503default

Body

application/json

codestring

A machine readable code of the error.

messagestring

A description of the error. This error is not intended to be displayed to the end-user, rather it is it designed to relay information to the application developer.

Request

JavaScriptCurlPython

const response = await fetch('http://localhost:8080/api/rest/firebase_session', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

400401403404409500501503default

{
  "code": "text",
  "message": "text"
}

Creates a Session using Facebook

Begins a session by accepting a Facebook OAuth token, SocialEngine Application ID, and the configuration ID for the application. This will generate a Session instance and return the result to the client.

POSThttp://localhost:8080/api/rest/facebook_session

Body

application/json

applicationNameOrId*any

applicationConfigurationNameOrId*any

facebookOAuthAccessToken*any

Response

400401403404409500501503default

Body

application/json

codestring

A machine readable code of the error.

messagestring

A description of the error. This error is not intended to be displayed to the end-user, rather it is it designed to relay information to the application developer.

Request

JavaScriptCurlPython

const response = await fetch('http://localhost:8080/api/rest/facebook_session', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

400401403404409500501503default

{
  "code": "text",
  "message": "text"
}

Creates a Session using Apple Sign-In

Begins a session by accepting an auth code and identity token. Upon successful validation against Apple's sign-in APIs, this will return a Session which can be used for authentication. If there isno User associated with the supplied credentials, this will implicitly create a new account and will include that account information in the response. If there is an account, or this method receives an existing session key, this will link the existing account to apple if the account was not previously linked.

POSThttp://localhost:8080/api/rest/applesignin_session

Body

application/json

applicationNameOrId*any

identityToken*any

Response

400401403404409500501503default

Body

application/json

codestring

A machine readable code of the error.

messagestring

A description of the error. This error is not intended to be displayed to the end-user, rather it is it designed to relay information to the application developer.

Request

JavaScriptCurlPython

const response = await fetch('http://localhost:8080/api/rest/applesignin_session', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

400401403404409500501503default

{
  "code": "text",
  "message": "text"
}