Searching...

Matching results

    Administration Logs

    Lists administration activity such as authentication events.

    An administration log is related to a company. It exposes its timestamp as well as details depending on its type.

    Field Description Read Only Type
    companyId Company's unique identifier. true uid
    timestamp The date time in milliseconds when this event occurred. true timestamp
    type Says which kind of event we are logging. Possible values: authentication true string
    details Detailed information about this log. The table below describes the information exposed for an 'authentication' event. object

    authentication

    Authentication logs are raised when the access tokens are generated on behalf of a user, when the user authenticates correctly or when the user has been blocked.

    Field Description Read Only Type
    user The email of the user who has raised this event. true string
    status The nature of this authentication event. SUCCESS when the user got an access token, or authenticated correctly, BLOCKED when the user has been blocked after several unsuccessful attempts. true string
    entrypoint Says which entrypoint generated this log. As we lay strongly on oauth APIs, the only value is OAUTH_TOKEN. true string

    This is a complete representation of an administration log.

    [
        {
            "companyId": "af2061ef883449ae845866672097d005",
            "timestamp": 1518176568844,
            "type": "authentication",
            "details": {
                "user": "anyuser@sierrawireless.com",
                "status": "SUCCESS",
                "entrypoint": "OAUTH_TOKEN"
            }
        }
    ]

    /api/v1/administration/logs

    Returns a list of logs.

    Request

    GET https://eu.airvantage.net/api/v1/administration/logs?company=1&type=authentication&user=anyuser@sierrawireless.com

    Response
    200 OK

    HTTP/1.1 200 OK
    Content-Type: application/json
    ...
    [
        {
            "companyId": "af2061ef883449ae845866672097d005",
            "timestamp": 1518176568844,
            "type": "authentication",
            "details": {
                "user": "anyuser@sierrawireless.com",
                "status": "SUCCESS",
                "entrypoint": "OAUTH_TOKEN"
            }
        }
    ]
    Name Description Use Default Type Operand
    company The user's company. required context company uid string =
    type Gives the possibility to display only one kind of logs. See Administration Logs fields optional string =

    Depending on the log type, it is possible to filter by attributes in the details. In this case the type parameter is required

    authentication

    Name Description Use Default Type Operand
    user Filter authentication logs by user email. optional string =
    status Display only authentication logs for a specific status. See Administration Logs fields optional string =
    Name Description
    company.unknown The specified uid does not match with any existing company.
    HTTP Method GET
    Requires Authentication Yes
    Rate Limited Yes
    Headers None
    Permissions airvantage.administration
    TOP