API Documentation - End-User RESTful API

Documentation

Expand commands

GET

Doc

/doc

text/html

Get this documentation page

Access scope : Public

HTTP Status Code
Code	Message	Meaning
200	OK	The request has succeeded

End-User

Expand commands

Accounts management

Expand commands

POST

End-user Account

/enduser/email/validation/{token}

application/json

Validate logged-in user email given a token. A token can only be used once.

Access scope : Public

Parameters
Type	Name	Value	Description
Path Variable	token	"string value"	The token

Response
Type	Name	Value	Description
Response Body	(JSON)	{ "emailValidated" : false }

HTTP Status Code
Code	Message	Meaning
200	OK	The request has succeeded

POST

End-user Account

/enduser/password/reset

application/json

Reset an end-user password, given the user name and email address

Access scope : Public

Parameters
Type	Name	Value	Description
Request Body	(JSON)	{ "userId" : "a user id", "email" : "an email" }	Information to reset the end-user password

HTTP Status Code
Code	Message	Meaning
200	OK	The request has succeeded

POST

End-user Account

/enduser/{userId}/validation

application/json

Ask a single-use token for user account and email validation. A token can only be used once. Asking for a new token will cancel the previous one.

Access scope : Public

Parameters
Type	Name	Value	Description
Path Variable	userId	"string value"	The user id

HTTP Status Code
Code	Message	Meaning
200	OK	The request has succeeded

POST

End-user Account

/enduser/{userId}/validation/{token}

application/json

Validate user account and email given a token. A token can only be used once.

Access scope : Public

Parameters
Type	Name	Value	Description
Path Variable	userId	"string value"	The user id
Path Variable	token	"string value"	The token

Response
Type	Name	Value	Description
Response Body	(JSON)	{ "emailAndAccountValidated" : false }

HTTP Status Code
Code	Message	Meaning
200	OK	The request has succeeded

GET

Enduser

/enduser/existingUserIds/{userId}

application/json

Check if the given 'userId' exist. (This operation is rate limited, do not abuse it)

Access scope : Public

Parameters
Type	Name	Value	Description
Path Variable	userId	"string value"	The id of the user

Response
Type	Name	Value	Description
Response Body	(JSON)	{ "userExists" : false }

HTTP Status Code
Code	Message	Meaning
200	OK	The request has succeeded

POST

Main end-user Account

/enduser/mainAccount

application/json

Create enduser main account

	-> last name, first name
	-> email address
	-> phone and mobile phone numbers
	-> locale
	-> extra emails
	-> setup label

Access scope : Public

Parameters

Type

Name

Value

Description

Request Body

(JSON)

{
  "location" : {
    "city" : "a city",
    "country" : "a country",
    "postalCode" : "a postal code",
    "addressLine1" : "an address line1",
    "addressLine2" : "an address line2",
    "timezone" : "a timezone",
    "longitude" : 0.12345,
    "latitude" : 0.12345,
    "twilightMode" : 1,
    "twilightAngle" : "NAUTICAL",
    "twilightCity" : "a twilight city",
    "summerSolsticeDuskMinutes" : 1,
    "winterSolsticeDuskMinutes" : 1,
    "twilightOffsetEnabled" : false,
    "dawnOffset" : 1,
    "duskOffset" : 1,
    "tariffSettings" : {
      "tariffMode" : "offPeakWeekDays",
      "tariffs" : [ {
        "dayTariffs" : [ {
          "name" : "tariff0",
          "startTime" : "00:01"
        } ],
        "dayWeekName" : "SAT"
      } ]
    }
  },
  "label" : "a main enduser account label",
  "templateName" : "a template name",
  "applicationId" : "an application id",
  "activationTimestamp" : 120123456790,
  "expirationTimestamp" : 120123456794,
  "gatewayId" : "A comma separated list of gateway ids",
  "endUser" : {
    "userId" : "a user id",
    "title" : 1,
    "firstName" : "a first name",
    "lastName" : "a last name",
    "email" : "an email",
    "phoneNumber" : "a phone number",
    "mobilePhone" : "a mobile phone",
    "locale" : "a locale",
    "commercialMailAgreement" : true,
    "extraEmails" : [ {
      "email" : "an email"
    } ]
  },
  "password" : "a password"
}

All information about the new main user

HTTP Status Code
Code	Message	Meaning
201	CREATED	The request has been fulfilled and resulted in a new resource being created

POST

Password quality check

/enduser/password/check

application/json

Check the quality of a given username/password pair. A negative score means the password will be rejected.

Access scope : Public

Parameters
Type	Name	Value	Description
Request Body	(JSON)	{ "userId" : "user1", "userPassword" : "p4ssw0rd!" }

Response
Type	Name	Value	Description
Response Body	(JSON)	{ "score" : 52, "weaknesses" : [ { "key" : "PWD_COMMON_TOKEN", "label" : "Password contains a word or sequence which is too common" } ], "qualityClass" : "Medium" }

HTTP Status Code
Code	Message	Meaning
200	OK	The request has succeeded

Login & Session

Establishing or terminating an API session

Expand commands

GET

Current user

/authenticated

application/json

Test if the current session is authenticated

Access scope : Public

Response
Type	Name	Value	Description
Response Body	(JSON)	{ "authenticated" : false }

HTTP Status Code
Code	Message	Meaning
200	OK	The request has succeeded

POST

/login

application/json

Authenticate and create an API session allowing access to the other operations.
Caller must provide one of [userId+userPassword, userId+ssoToken, accessToken, jwt]

Access scope : Public

> Test operation

Parameters
Type	Name	Value	Description
Request Parameter	userId	"string value"	(Optional) a user name
Request Parameter	userPassword	"string value"	(Optional) a user password
Request Parameter	ssoToken	"string value"	(Optional) an Overkiz single-sign-on token obtained through Overkiz webservices
Request Parameter	accessToken	"string value"	(Optional) an OAuth access token obtained from an OAuth service
Request Parameter	jwt	"string value"	(Optional) a Json Web Token obtained from another service
Request Parameter	applicationId	"string value"	(Optional) client application ID
Request Parameter	apiKey	"string value"	(Optional) client API Key
Request Parameter	setupOID	"string value"	(Optional) setup OID

Response
Type	Name	Value	Description
Response Body	(JSON)	{ "success" : false, "roles" : [ { "name" : "a security role name" } ], "extraAttributes" : { "some extra attributes" : "some extra attributes" } }	Returns { success: true } on successful login

HTTP Status Code
Code	Message	Meaning
200	OK	The request has succeeded

POST

Logout

/logout

application/json

Invalidate the current user session

Access scope : Public

Response
Type	Name	Value	Description
Response Body	(JSON)	{ "logout" : false }	Returns { "logout": true } on successful logout

HTTP Status Code
Code	Message	Meaning
200	OK	The request has succeeded

GET

Other

/accountManagement/resetPasswordFailure

application/json

No available description

Access scope : Public

Parameters
Type	Name	Value	Description
Request Parameter	errorMessage	"string value"	(Optional)

HTTP Status Code
Code	Message	Meaning
200	OK	The request has succeeded

GET

Other

/accountManagement/resetPasswordSuccess

application/json

No available description

Access scope : Public

HTTP Status Code
Code	Message	Meaning
200	OK	The request has succeeded

Terms of use

Expand commands

Accounts management

Expand commands

POST

TermsOfUse

/termsOfUse/{gatewayId}/accept/{token}

application/json

Accept Terms of Use given a token. A token can only be used once.

Access scope : Public

Parameters
Type	Name	Value	Description
Path Variable	gatewayId	"string value"	The gateway id
Path Variable	token	"string value"	The token

Response
Type	Name	Value	Description
Response Body	(JSON)	{ "TermsOfUseValidated" : false }

HTTP Status Code
Code	Message	Meaning
200	OK	The request has succeeded

POST

TermsOfUse

/termsOfUse/{gatewayId}/decline/{token}

application/json

Decline Terms of Use given a token. A token can only be used once.

Access scope : Public

Parameters
Type	Name	Value	Description
Path Variable	gatewayId	"string value"	The gateway id
Path Variable	token	"string value"	The token

Response
Type	Name	Value	Description
Response Body	(JSON)	{ "TermsOfUseDeclined" : false }

HTTP Status Code
Code	Message	Meaning
200	OK	The request has succeeded

End-User RESTful API Operations

Expand/collapse all

Hide/show deprecated

Documentation

End-User

Accounts management

Login & Session

Terms of use

Accounts management