Home B2Core IB API Authentications

Authentications

On this page:

THE AUTHENTICATION OBJECT	A detailed description of the JSON object
GET[base]/authentications	Get an authentications list
GET[base]/authentications/{authenticationId}	Get authentication details

The Authentication object

This object provides the following data about an attempt to obtain an API access token:

authenticationId string: The authentication identifier.
clientIdentifier integer: The client identifier.
ipAddress string: The IP address from which an access token was obtained.
userAgent string: The information about the user agent originating the request. A string consists of one or more product identifiers, each followed by zero or more comments.
createDate string: The date and time when the object has been created.
updateDate string: The date and time when the object has been last updated.

    THE AUTHENTICATION OBJECT
  
{
  "authenticationId": "6006dda272f002519c3eb505",
  "clientIdentifier": 68,
  "ipAddress": "185.155.96.184",
  "userAgent": "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/605.1.15 (KHTML, like Gecko) Version/14.1.2 Safari/605.1.15",
  "createTime": "2021-01-01T00:00:00+00:00",
  "updateTime": "2021-01-01T00:00:00+00:00"
}

Get an authentications list

Use this method to obtain a list of all attempts to obtain API access tokens.

To obtain detailed information about a specified attempt, use a separate method to get authentication details.

Request

Header parameters:

Authorization: Bearer <token>

Query parameters:

This method supports pagination, sorting, and filtering. For details on applying the parameters, refer to the Query parameters section. Possible parameters for filtering and sorting are listed below. For values description, refer to the Authentication object.

Possible values for the filter parameter:

clientIdentifier
ipAddress
userAgent
createDate
updateDate

Possible values for the sort_by parameter:

authenticationId
clientIdentifier
ipAddress
userAgent
createTime (default)
updateTime

GET[base]/authentications

curl --location -g --request GET 'https://your.base-url.here/authentications?limit=10&offset=0&sort_by=createTime&sort_order=desc&filter[clientIdentifier]=68&filter[createDate]=2021-01-01&filter[ipAddress]=185.155.96.184&filter[updateDate]=2021-01-01&filter[userAgent]=Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/605.1.15 (KHTML, like Gecko) Version/14.1.2 Safari/605.1.15' \
--header 'Authorization: Bearer <token>'

Response

Body:

In case of success, the response body contains an array of Authentication objects providing information about all authentication attempts that correspond to the query parameters specified in the request.

Get authentication details

Use this method to obtain detailed information about a specified attempt to obtain the API access token.

To obtain a list of all attempts, use a separate method to get a list of authentications.

Request

Header parameters:

Authorization: Bearer <token>

Path parameters:

authenticationId required: The identifier of an authentication.

GET[base]/authentications/{authenticationId}

curl --location --request GET 'https://your.base-url.here/authentications/60ba407d15951453e60e49f8' \
--header 'Authorization: Bearer <token>'

Response

Body:

In case of success, the response body contains an Authentication object providing information about the specified authentication attempt.