Skip to main content
Skip table of contents

4.1.9. Endpoint Access Control Access Requests (Get) Endpoint

NOT AVAILABLE IN SAAS


Request URL: https://<hostname>/ekranapi/AccessRequests/GetEndpointAccessRequests


Required headers:

Parameter

Required

Description

ApiKeyYesUsed to authenticate the request. 

Example request header: ApiKey: xJ)tsCNcpj)l+]}(@_|lt!t………


Name

Description

Type

Request Parameters

Name

Description

Type

Format

Required

Endpoint Access Control Access Requests

Gets a list of endpoint access control access requests that have been processed (with detailed info for each endpoint access control access request).

GET

start

Endpoint access control access requests that have been processed after this time will be added to the selection.

string

Examples:

"2021-04-01"

"2021-04-01T12:00"

"2021-04-01T12:00:00"

No

end

Endpoint access control access requests that have been processed before this time will be added to the selection.

string

Examples:

"2021-04-01"

"2021-04-01T12:00"

"2021-04-01T12:00:00"

No

count

The number of endpoint access control access requests to be returned in 1 request.

Default value: 1000

Max value: 1000

int

Any integer from 0 to 1000.

No

afterId

If there are more than 1000 endpoint access control access requests, the next batch can be requested by using this parameter.

int

Any positive integer.

No

Notes:

1. If the optional time parameters are not specified in the endpoint access control request:

- If both the start and end parameters are not specified, all endpoint access control requests in the whole database are added to the response.

- If the start parameter is not specified, all endpoint access control requests in the whole database before the end date/time are added to the response.

- If the end parameter is not specified, all endpoint access control requests in the whole database after the start date/time are added to the response.


The endpoint access requests response (status 200 = successful):

Response Parameters

Name (& Type)

Description

Example Response

afterId (int):


The ID of the first endpoint access control access request (i.e. the first id) in the batch of 1000 such requests.

{
  "afterId": null,
  "requests": [
    {
      "id": 1,
      "requestedAt": "2023-02-08T13:26:37.763",
      "userName": "windev2210eval\\user",
      "sessionDuration": "00:40:34.4150000",
      "sessionProductiveDuration": "00:28:02.8690000",
      "status": "Approved",
      "remoteIp": "172.31.240.1",
      "statusChangedAt": "2023-02-08T13:32:34.437",
      "statusChangedBy": "admin",
      "statusChangeComment": "approve message"
    },
    {
      "id": 2,
      "requestedAt": "2023-02-08T14:30:55.527",
      "userName": "windev2210eval\\user",
      "sessionDuration": "00:04:15.2660000",
      "sessionProductiveDuration": "00:04:12.2760000",
      "status": "Approved",
      "remoteIp": "172.31.240.1",
      "statusChangedAt": "2023-02-08T14:31:05.187",
      "statusChangedBy": "admin",
      "statusChangeComment": "approve 2 message"
    }
  ]
}

requests:

The list (i.e. array) of endpoint access control access requests (with the following detailed info for each request):

  • id (int)
  • A service field required for pagination.
  • requestedAt (date)
  • The date and time when the request was made.
  • userName (string)
  • The user name of the user requesting access.
  • sessionDuration (timespan)
  • The total session time
  • sessionProductiveDuration (timespan)
  • The total session time excluding idle time.
  • remoteIp (string)
  • The IP address of the user requesting access.
  • status (string)
  • The access request status (Approved/Denied/Expired).
  • statusChangedAt (date)
  • The date and time when the request status was approved.
  • statusChangedBy (string)
  • The user name of the user who changed the status of the request.
  • statusChangeComment (string)
  • A comment left by the user who changed the status of the request.


NOTE: If the requested count is more than 1000, a status code of "400" is returned.


JavaScript errors detected

Please note, these errors can depend on your browser setup.

If this problem persists, please contact our support.