Access Requests

list access requests

get

/api/v3/access-requests

Authorizations

Query parameters

days_offsetinteger · int64 | nullable

user_idstring | nullable

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url 'https://api.apono.io/api/v3/access-requests' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN'

200

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": 1,
    "limit": 1,
    "offset": 1
  }
}

OK

create access request

post

/api/v3/access-requests

Authorizations

Body

user_idstringrequired

integration_idstringrequired

resource_idsstring[]required

permissionsstring[]required

justificationstringrequired

duration_in_secinteger · int32 | nullable

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'https://api.apono.io/api/v3/access-requests' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN' \
  --header 'Content-Type: application/json' \
  --data '{
    "user_id": "text",
    "integration_id": "text",
    "resource_ids": [
      "text"
    ],
    "permissions": [
      "text"
    ],
    "justification": "text",
    "duration_in_sec": 1
  }'

200

200

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

OK

Revoke multiple access requests

post

/api/v3/access-requests-bulk/revoke

Authorizations

Body

request_idsstring[]required

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'https://api.apono.io/api/v3/access-requests-bulk/revoke' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN' \
  --header 'Content-Type: application/json' \
  --data '{
    "request_ids": [
      "text"
    ]
  }'

200

200

{
  "message": "text"
}

OK

get access request

get

/api/v3/access-requests/{id}

Authorizations

Path parameters

idstringrequired

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url 'https://api.apono.io/api/v3/access-requests/{id}' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN'

200

200

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

OK

get access request access details

get

/api/v3/access-requests/{id}/access-details

Authorizations

Path parameters

idstringrequired

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url 'https://api.apono.io/api/v3/access-requests/{id}/access-details' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN'

200

200

{
  "details": "text"
}

OK

reset access request credentials

post

/api/v3/access-requests/{id}/reset

Authorizations

Path parameters

idstringrequired

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'https://api.apono.io/api/v3/access-requests/{id}/reset' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN'

200

200

{
  "message": "text"
}

OK

get selectable integrations

get

/api/v3/selectable-integrations

Authorizations

Query parameters

user_idstring | nullable

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url 'https://api.apono.io/api/v3/selectable-integrations' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN'

200

200

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

OK

get selectable resource types

get

/api/v3/selectable-integrations/{integration_id}/resource-types

Authorizations

Path parameters

integration_idstring | nullablerequired

Query parameters

user_idstring | nullable

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url 'https://api.apono.io/api/v3/selectable-integrations/{integration_id}/resource-types' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN'

200

200

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

OK

get selectable permissions

get

/api/v3/selectable-integrations/{integration_id}//{resource_type}/permissions

Authorizations

Path parameters

integration_idstring | nullablerequired

resource_typestringrequired

Query parameters

user_idstring | nullable

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url 'https://api.apono.io/api/v3/selectable-integrations/{integration_id}/{resource_type}/permissions' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN'

200

200

{
  "data": [
    "text"
  ],
  "pagination": {
    "total": 1,
    "limit": 1,
    "offset": 1
  },
  "allow_multiple": true
}

OK

get selectable resources

get

/api/v3/selectable-integrations/{integration_id}//{resource_type}/resources

Authorizations

Path parameters

integration_idstring | nullablerequired

resource_typestringrequired

Query parameters

user_idstring | nullable

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url 'https://api.apono.io/api/v3/selectable-integrations/{integration_id}/{resource_type}/resources' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN'

200

200

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

OK