Users

Get a list of configured user logins

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

GET

/gb/user/logins

curl --request GET \
  --url 'https://api.catch-e.com/gb/user/logins?user_id=%3Cstring%3E&user_login=%3Cstring%3E&service=%3Cstring%3E&status=active&page=1&page_size=25' \
  --header 'Authorization: <api-key>'

{
  "_embedded": {
    "gb_user_logins": [
      {
        "login": "exampleUsername",
        "password": "examplePassword",
        "service": "maclease_partner",
        "status_flag": "active",
        "user_id": "12345",
        "user_login_id": "16238953344683479026"
      }
    ]
  },
  "_links": {
    "first": {
      "href": "https://api.catch-e.com/gb/user/logins/"
    },
    "last": {
      "href": "https://api.catch-e.com/gb/user/logins/?page=1"
    },
    "self": {
      "href": "https://api.catch-e.com/gb/user/logins/?page=1"
    }
  },
  "page": 1,
  "page_count": 1,
  "page_size": 25,
  "total_items": 1
}

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

Query Parameters

user_idstringquery

(Optional) Filter by User Id

(Optional) Filter by User Login

servicestringquery

(Optional) Filter by Service

statusenum<string>[]querydefault:active

Optional status

pageintegerquerydefault:1

Optional page number

page_sizeintegerquerydefault:25

Optional page size

Response

Success

_embeddedobject

Show child attributes

_linksobject

pagenumber

Example: 1

page_countnumber

Example: 1

page_sizenumber

Example: 25

total_itemsnumber

Example: 1

Still need help? Ask the team