Gets a list of Application Users.

/cnbs/v1/apu/users

GET

• Parameters (URI Parameter)
  • User ID (user_id)
    • GUID identifying an application user (Obtained by a Users Search).
  • Login (login)
  • Email (email)
  • User Status (user_status)
  • Profile (profile)
  • Third Party Identifier (third_party_id)
  • Password Reset Token (password_reset_token)
  • Confirmation Token (confirmation_token)
  • Invite Token (invite_token)
  • Search String (search_string)

cURL:

curl -X GET "https://<<your.server.here>>/cnbs/v1/apu/users?sap-client=800&sap-language=EN&apiid=CNBSMV01R -H content-type: application/json -H  cnbssysid: nR4kLO/8HCiuv+1hev5fbMgcMpOwhKf3GvJZvxZ3ZPQ=

The response consists of a user list table (data) and a status (status).

• User List (data)
  • User ID (user_id)
    • System Generated
  • Login Name (login)
  • First Name (first_name)
  • Last Name (last_name)
  • Company (company)
  • Email Address (email)
  • Invite Token (invite_token)
  • Number of Logins (num_logins)
  • Status (status)
  • Password Reset Token (password_reset_token)
  • Salt (salt)
  • Hash (hash)
  • Primary Account Type ID (primary_account_type_id)
  • User Role (user_role)
  • Confirmation Token (confirmation_token)
  • Date Created (created_date)
  • Time Created (created_time)
  • Last Change Date (updated_date)
  • Last Change Time (updated_time)
  • Last Login Date (last_login_date)
  • Last Login Time (last_login_time)
  • Date of Last Password Change (last_pwd_change_date)
  • Time of Last Password Change (last_pwd_change_time)
  • Password Change Required? (require_password_change)
  • Third Party ID (third_party_id)
• Status (status)
  • Message Type (message_type)
    • SAP Message Type.
      • Errors:
        • E = Error
        • A = Abort
        • X = Exception
      • Others:
        • S = Success
        • W = Warning
        • I = Information
  • Message Identifier (message_identification)
    • SAP Message ID.
  • Message Number (message_number)
    • SAP Message Number.
  • Message Line (message_line_string)
    • SAP Message Text.

JSON:

{
  "data": [
{
            "user_id": "A959E6704DF21EEA97F78B7E1430CA56",
            "login": "sjones",
            "first_name": "Steven",
            "last_name": "Jones",
            "company": "CNBS",
            "email": "steven.jones@cnbssoftware.com",
            "invite_token": "",
            "num_logins": 5,
            "status": "active",
            "password_reset_token": "",
            "salt": "dfhskfdjowejsks",
            "hash": "yuerwiiweruiew",
            "primary_account_type_id": "Payer",
            "user_role": "user",
            "confirmation_token": "",
            "created_date": "00000000",
            "created_time": "000000",
            "updated_date": "20200413",
            "updated_time": "130830",
            "last_login_date": "00000000",
            "last_login_time": "000000",
            "last_pwd_change_date": "00000000",
            "last_pwd_change_time": "000000",
            "require_password_change": "",
            "third_party_id": ""
        }
  ],
  "status": {
    "message_type": "S",
    "message_identification": "/CNBS/X_API",
    "message_number": 10,
    "message_line_string": "Request successfully processed ,document selected 1"
  }
}