Access Requests

list access requests

GEThttps://api.apono.io/api/v3/access-requests

Query parameters

Response

200

OK

Body

application/json

data*array of AccessRequest (object)

pagination*PaginationInfo (object)

Request

JavaScriptCurlPython

const response = await fetch('https://api.apono.io/api/v3/access-requests', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200

{
  "data": [
    {
      "request_id": "text",
      "friendly_request_id": "text",
      "user_id": "text",
      "status": "PENDING",
      "integration_id": "text",
      "resource_ids": [
        "text"
      ],
      "permissions": [
        "text"
      ],
      "justification": "text"
    }
  ],
  "pagination": {
    "total": 0,
    "limit": 0,
    "offset": 0
  }
}

create access request

POSThttps://api.apono.io/api/v3/access-requests

Body

application/json

user_id*string

integration_id*string

resource_ids*array of string

permissions*array of string

justification*string

duration_in_secnullable integer (int32)

Response

200

OK

Body

application/json

request_id*string

friendly_request_id*string

user_id*string

status*AccessStatusModel (enum)

PENDINGAPPROVEDREJECTEDGRANTEDREVOKINGEXPIREDFAILED

integration_id*string

resource_ids*array of string

permissions*array of string

justification*string

Request

JavaScriptCurlPython

const response = await fetch('https://api.apono.io/api/v3/access-requests', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "user_id": "text",
      "integration_id": "text",
      "resource_ids": [
        "text"
      ],
      "permissions": [
        "text"
      ],
      "justification": "text"
    }),
});
const data = await response.json();

Response

200

{
  "request_id": "text",
  "friendly_request_id": "text",
  "user_id": "text",
  "status": "PENDING",
  "integration_id": "text",
  "resource_ids": [
    "text"
  ],
  "permissions": [
    "text"
  ],
  "justification": "text"
}

Revoke multiple access requests

POSThttps://api.apono.io/api/v3/access-requests-bulk/revoke

Body

application/json

request_ids*array of string

Response

200

OK

Body

application/json

message*string

Request

JavaScriptCurlPython

const response = await fetch('https://api.apono.io/api/v3/access-requests-bulk/revoke', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "request_ids": [
        "text"
      ]
    }),
});
const data = await response.json();

Response

200

{
  "message": "text"
}

get access request

GEThttps://api.apono.io/api/v3/access-requests/{id}

Path parameters

id*string

Response

200

OK

Body

application/json

request_id*string

friendly_request_id*string

user_id*string

status*AccessStatusModel (enum)

PENDINGAPPROVEDREJECTEDGRANTEDREVOKINGEXPIREDFAILED

integration_id*string

resource_ids*array of string

permissions*array of string

justification*string

Request

JavaScriptCurlPython

const response = await fetch('https://api.apono.io/api/v3/access-requests/{id}', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200

{
  "request_id": "text",
  "friendly_request_id": "text",
  "user_id": "text",
  "status": "PENDING",
  "integration_id": "text",
  "resource_ids": [
    "text"
  ],
  "permissions": [
    "text"
  ],
  "justification": "text"
}

get access request access details

GEThttps://api.apono.io/api/v3/access-requests/{id}/access-details

Path parameters

id*string

Response

200

OK

Body

application/json

details*string

Request

JavaScriptCurlPython

const response = await fetch('https://api.apono.io/api/v3/access-requests/{id}/access-details', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200

{
  "details": "text"
}

reset access request credentials

POSThttps://api.apono.io/api/v3/access-requests/{id}/reset

Path parameters

id*string

Response

200

OK

Body

application/json

message*string

Request

JavaScriptCurlPython

const response = await fetch('https://api.apono.io/api/v3/access-requests/{id}/reset', {
    method: 'POST',
    headers: {},
});
const data = await response.json();

Response

200

{
  "message": "text"
}

get selectable integrations

GEThttps://api.apono.io/api/v3/selectable-integrations

Query parameters

Response

200

OK

Body

application/json

data*array of SelectableIntegration (object)

pagination*PaginationInfo (object)

Request

JavaScriptCurlPython

const response = await fetch('https://api.apono.io/api/v3/selectable-integrations', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200

{
  "data": [
    {
      "id": "text"
    }
  ],
  "pagination": {
    "total": 0,
    "limit": 0,
    "offset": 0
  }
}

get selectable resource types

GEThttps://api.apono.io/api/v3/selectable-integrations/{integration_id}/resource-types

Path parameters

integration_id*nullable string

Query parameters

Response

200

OK

Body

application/json

data*array of SelectableResourceType (object)

pagination*PaginationInfo (object)

Request

JavaScriptCurlPython

const response = await fetch('https://api.apono.io/api/v3/selectable-integrations/{integration_id}/resource-types', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200

{
  "data": [
    {
      "id": "text",
      "name": "text"
    }
  ],
  "pagination": {
    "total": 0,
    "limit": 0,
    "offset": 0
  }
}

get selectable permissions

GEThttps://api.apono.io/api/v3/selectable-integrations/{integration_id}/{resource_type}/permissions

Path parameters

integration_id*nullable string

resource_type*string

Query parameters

Response

200

OK

Body

application/json

data*array of string

pagination*PaginationInfo (object)

allow_multiple*boolean

Request

JavaScriptCurlPython

const response = await fetch('https://api.apono.io/api/v3/selectable-integrations/{integration_id}/{resource_type}/permissions', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200

{
  "data": [
    "text"
  ],
  "pagination": {
    "total": 0,
    "limit": 0,
    "offset": 0
  },
  "allow_multiple": false
}

get selectable resources

GEThttps://api.apono.io/api/v3/selectable-integrations/{integration_id}/{resource_type}/resources

Path parameters

integration_id*nullable string

resource_type*string

Query parameters

Response

200

OK

Body

application/json

data*array of SelectableResource (object)

pagination*PaginationInfo (object)

Request

JavaScriptCurlPython

const response = await fetch('https://api.apono.io/api/v3/selectable-integrations/{integration_id}/{resource_type}/resources', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200

{
  "data": [
    {
      "id": "text",
      "type": "text",
      "name": "text"
    }
  ],
  "pagination": {
    "total": 0,
    "limit": 0,
    "offset": 0
  }
}