Users

Create a new user login

This method requires the UserLogins:Create permission to be associated with your role.

POST

/gb/user/logins

curl --request POST \
  --url https://api.catch-e.com/gb/user/logins \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "login": "exampleUsername",
  "password": "examplePassword",
  "service": "maclease_partner",
  "status_flag": "active",
  "user_id": "12345"
}
'

{
  "login": "exampleUsername",
  "password": "examplePassword",
  "service": "maclease_partner",
  "status_flag": "active",
  "user_id": "12345",
  "user_login_id": "16238953344683479026"
}

Authorizations

Authorizationstringheaderrequired

For accessing the API a valid token must be passed in all the queries in the 'Authorization' header.

A valid token is generated by the API and returned by the /authenticate method by supplying a valid username and password.

The following syntax must be used in the 'Authorization' header :

Bearer aaaaaa/bbbbbb.ccccccc.dddddd

Body

JSON payload

(Optional) Username for the specified service

Example: exampleUsername

passwordstring

(Optional) Password for the specified service

Example: examplePassword

serviceenum<string>required

Service

Available options: 1link, red_book, st_george_nbi2, navman, maclease_partner, azure_ad

Example: maclease_partner

status_flagenum<string>default:active

Available options: active, inactive

user_idstringrequired

User Id

Example: 12345

Response

Success

passwordstring

servicestring

status_flagenum<string>

Available options: active, inactive

user_idstring

Still need help? Ask the team