Authorization history

Use these methods to view the log of client authorization attempts in the B2Core UI.

GET[host]/api/v2/clients/authorizations

Get authorization history

GET[host]/api/v2/clients/authorizations/{authorizationId}

Get authorization details

Get authorization history

Use this method to obtain the log of client authorization attempts in the B2Core UI.

Note

If such a request is made by an admin user that is only permitted to view clients with certain tags, a response includes only the authorization history of clients marked with these tags.

Use a separate method to get details about a specified authorization record.

Request

Header parameters:

  • Authorization: Bearer <access_token>

Query parameters:

The following filter parameters are available for this method:

clientId

The client identifier.

ip

The IP address from which a client signed in to the B2Core UI.

status

The result of a sign-in attempt. Possible values:

  • success

  • failure

The following sorting parameter is available for this method:

authDateTime

The date and time when a client signed in to the B2Core UI.

Refer to the Query parameters section in the API Overview for details on applying filter and sorting parameters.

GET[host]/api/v2/clients/authorizations

curl --location -g --request GET 'https://host.name/api/v2/clients/authorizations?limit=10&offset=0&sort_order=desc&sort_by=authDateTime&filter[clientId]=1&filter[ip]=000.000.00.000&filter[status]=success' \
--header 'Authorization: Bearer <token>' \
--header 'accept-language: ja'

Response

A response includes an array of Authorization Record objects providing information about the authorization attempts matching the request parameters.

Get authorization details

Use this method to obtain detailed information about a specified authorization record.

Use a separate method to get authorization history.

Request

Header parameters:

  • Authorization: Bearer <access_token>

Path parameters:

authorizationId required

The identifier of an authorization record.

GET[host]/api/v2/clients/authorizations/{authorizationId}

curl --location --request GET 'https://host.name/api/v2/clients/authorizations/1' \
--header 'Authorization: Bearer <token>' \
--header 'accept-language: ja'

Response

A response includes an Authorization Record object providing information about the specified authorization record.