LogoLogo
API Reference
HomeDocumentation and GuidesAPI ReferenceMetadata for Integration Config
API Reference
HomeDocumentation and GuidesAPI ReferenceMetadata for Integration Config
  • API OVERVIEW
    • Getting started using Apono API
    • API Authentication
  • APONO
    • Access Bundles
    • Access Flows
    • Identities
    • Connectors
    • Integrations
    • Users
    • Access Requests
    • Activity
Powered by GitBook
On this page

Was this helpful?

Export as PDF
  1. APONO

Access Requests

PreviousUsersNextActivity

Last updated 5 months ago

Was this helpful?

get access request

get
Authorizations
Path parameters
idstringRequired
Responses
application/json
objectOptional
get
GET /api/v3/access-requests/{id} HTTP/1.1
Host: api.apono.io
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
200

OK

{
  "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

get
Authorizations
Path parameters
idstringRequired
Responses
application/json
objectOptional
get
GET /api/v3/access-requests/{id}/access-details HTTP/1.1
Host: api.apono.io
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
200

OK

{
  "details": "text"
}

reset access request credentials

post
Authorizations
Path parameters
idstringRequired
Responses
application/json
objectOptional
post
POST /api/v3/access-requests/{id}/reset HTTP/1.1
Host: api.apono.io
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
200

OK

{
  "message": "text"
}

get selectable integrations

get
Authorizations
Query parameters
user_idstring | nullableOptional
Responses
application/json
objectOptional
get
GET /api/v3/selectable-integrations HTTP/1.1
Host: api.apono.io
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
200

OK

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

get selectable resource types

get
Authorizations
Path parameters
integration_idstring | nullableRequired
Query parameters
user_idstring | nullableOptional
Responses
application/json
objectOptional
get
GET /api/v3/selectable-integrations/{integration_id}/resource-types HTTP/1.1
Host: api.apono.io
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
200

OK

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

get selectable permissions

get
Authorizations
Path parameters
integration_idstring | nullableRequired
resource_typestringRequired
Query parameters
user_idstring | nullableOptional
Responses
application/json
objectOptional
get
GET /api/v3/selectable-integrations/{integration_id}/{resource_type}/permissions HTTP/1.1
Host: api.apono.io
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
200

OK

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

get selectable resources

get
Authorizations
Path parameters
integration_idstring | nullableRequired
resource_typestringRequired
Query parameters
user_idstring | nullableOptional
Responses
application/json
objectOptional
get
GET /api/v3/selectable-integrations/{integration_id}/{resource_type}/resources HTTP/1.1
Host: api.apono.io
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
200

OK

{
  "data": [
    {
      "id": "text",
      "type": "text",
      "name": "text"
    }
  ],
  "pagination": {
    "total": 1,
    "limit": 1,
    "offset": 1
  }
}
  • GETlist access requests
  • POSTcreate access request
  • POSTRevoke multiple access requests
  • GETget access request
  • GETget access request access details
  • POSTreset access request credentials
  • GETget selectable integrations
  • GETget selectable resource types
  • GETget selectable permissions
  • GETget selectable resources

list access requests

get
Authorizations
Query parameters
days_offsetinteger · int64 | nullableOptional
user_idstring | nullableOptional
Responses
application/json
objectOptional
get
GET /api/v3/access-requests HTTP/1.1
Host: api.apono.io
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
200

OK

{
  "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
  }
}

create access request

post
Authorizations
Body
user_idstringRequired
integration_idstringRequired
resource_idsstring[]Required
permissionsstring[]Required
justificationstringRequired
duration_in_secinteger · int32 | nullableOptional
Responses
application/json
objectOptional
post
POST /api/v3/access-requests HTTP/1.1
Host: api.apono.io
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 132

{
  "user_id": "text",
  "integration_id": "text",
  "resource_ids": [
    "text"
  ],
  "permissions": [
    "text"
  ],
  "justification": "text",
  "duration_in_sec": 1
}
200

OK

{
  "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

post
Authorizations
Body
request_idsstring[]Required
Responses
application/json
objectOptional
post
POST /api/v3/access-requests-bulk/revoke HTTP/1.1
Host: api.apono.io
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 24

{
  "request_ids": [
    "text"
  ]
}
200

OK

{
  "message": "text"
}