Access Requests
Filters results to requests made for the specified user. Accepts a user ID or email address
100
Filters results by request status. Supports multiple statuses.
OK
GET /api/user/v1/delegated-access-requests HTTP/1.1
Host: api.apono.io
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
OK
{
"items": [
{
"id": "text",
"status": "text",
"duration_in_sec": 1,
"justification": "text",
"creation_date": "text",
"revocation_date": "text",
"custom_fields": {
"ANY_ADDITIONAL_PROPERTY": "text"
},
"access_groups": [
{
"integration": {
"id": "text",
"name": "text"
},
"resource_types": [
{
"id": "text",
"label": "text"
}
]
}
],
"requestor": {
"id": "text",
"source_id": "text"
},
"grantee": {
"id": "text",
"source_id": "text"
},
"bundle": {
"id": "text",
"name": "text"
}
}
],
"pagination": {
"next_page_token": "text"
}
}
OK
GET /api/user/v1/delegated-access-requests/{id} HTTP/1.1
Host: api.apono.io
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
OK
{
"id": "text",
"status": "text",
"duration_in_sec": 1,
"justification": "text",
"creation_date": "text",
"revocation_date": "text",
"custom_fields": {
"ANY_ADDITIONAL_PROPERTY": "text"
},
"access_groups": [
{
"integration": {
"id": "text",
"name": "text"
},
"resource_types": [
{
"id": "text",
"label": "text"
}
]
}
],
"requestor": {
"id": "text",
"source_id": "text"
},
"grantee": {
"id": "text",
"source_id": "text"
},
"bundle": {
"id": "text",
"name": "text"
}
}
100
Filters access requests by the initiating user. Accepts a user ID or email address. If not provided, returns requests submitted by the authenticated user.
OK
GET /api/user/v4/access-requests HTTP/1.1
Host: api.apono.io
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
OK
{
"items": [
{
"id": "text",
"status": "text",
"duration_in_sec": 1,
"justification": "text",
"creation_date": "text",
"revocation_date": "text",
"custom_fields": {
"ANY_ADDITIONAL_PROPERTY": "text"
},
"access_groups": [
{
"integration": {
"id": "text",
"name": "text"
},
"resource_types": [
{
"id": "text",
"label": "text"
}
]
}
],
"requestor": {
"id": "text",
"source_id": "text"
},
"grantee": {
"id": "text",
"source_id": "text"
},
"bundle": {
"id": "text",
"name": "text"
}
}
],
"pagination": {
"next_page_token": "text"
}
}
Unique identifier or display name of the bundle. Either bundle_reference or entitlements is required
An explanation or reason for the access request
Duration in seconds for which access is requested
The user the access is being requested for. Accepts a user ID or email address. If not provided, access is requested for the authenticated user. Requires the caller to be authorized in the access flow to request access on behalf of the specified user
OK
POST /api/user/v4/access-requests HTTP/1.1
Host: api.apono.io
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 201
{
"bundle_reference": "text",
"entitlements": [
{
"resource_id": "text",
"permission_id": "text"
}
],
"justification": "text",
"duration_in_sec": 1,
"custom_fields": {
"ANY_ADDITIONAL_PROPERTY": "text"
},
"grantee": "text"
}
OK
[
{
"id": "text",
"status": "text",
"duration_in_sec": 1,
"justification": "text",
"creation_date": "text",
"revocation_date": "text",
"custom_fields": {
"ANY_ADDITIONAL_PROPERTY": "text"
},
"access_groups": [
{
"integration": {
"id": "text",
"name": "text"
},
"resource_types": [
{
"id": "text",
"label": "text"
}
]
}
],
"requestor": {
"id": "text",
"source_id": "text"
},
"grantee": {
"id": "text",
"source_id": "text"
},
"bundle": {
"id": "text",
"name": "text"
}
}
]
OK
GET /api/user/v4/access-requests/{id} HTTP/1.1
Host: api.apono.io
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
OK
{
"id": "text",
"status": "text",
"duration_in_sec": 1,
"justification": "text",
"creation_date": "text",
"revocation_date": "text",
"custom_fields": {
"ANY_ADDITIONAL_PROPERTY": "text"
},
"access_groups": [
{
"integration": {
"id": "text",
"name": "text"
},
"resource_types": [
{
"id": "text",
"label": "text"
}
]
}
],
"requestor": {
"id": "text",
"source_id": "text"
},
"grantee": {
"id": "text",
"source_id": "text"
},
"bundle": {
"id": "text",
"name": "text"
}
}
100
OK
GET /api/user/v4/access-requests/{id}/entitlements HTTP/1.1
Host: api.apono.io
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
OK
{
"items": [
{
"integration": {
"id": "text",
"name": "text"
},
"resource": {
"id": "text",
"source_id": "text",
"type": {
"id": "text",
"label": "text"
},
"name": "text"
},
"permission": {
"name": "text"
},
"status": "text"
}
],
"pagination": {
"next_page_token": "text"
}
}
An explanation or reason for the access request
OK
POST /api/user/v4/access-requests/{id}/request-again HTTP/1.1
Host: api.apono.io
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 75
{
"justification": "text",
"custom_fields": {
"ANY_ADDITIONAL_PROPERTY": "text"
}
}
OK
[
{
"id": "text",
"status": "text",
"duration_in_sec": 1,
"justification": "text",
"creation_date": "text",
"revocation_date": "text",
"custom_fields": {
"ANY_ADDITIONAL_PROPERTY": "text"
},
"access_groups": [
{
"integration": {
"id": "text",
"name": "text"
},
"resource_types": [
{
"id": "text",
"label": "text"
}
]
}
],
"requestor": {
"id": "text",
"source_id": "text"
},
"grantee": {
"id": "text",
"source_id": "text"
},
"bundle": {
"id": "text",
"name": "text"
}
}
]
OK
GET /api/v3/access-requests HTTP/1.1
Host: api.apono.io
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
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
}
}
OK
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
}
OK
{
"request_id": "text",
"friendly_request_id": "text",
"user_id": "text",
"status": "PENDING",
"integration_id": "text",
"resource_ids": [
"text"
],
"permissions": [
"text"
],
"justification": "text"
}
OK
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"
]
}
OK
{
"message": "text"
}
OK
GET /api/v3/access-requests/{id} HTTP/1.1
Host: api.apono.io
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
OK
{
"request_id": "text",
"friendly_request_id": "text",
"user_id": "text",
"status": "PENDING",
"integration_id": "text",
"resource_ids": [
"text"
],
"permissions": [
"text"
],
"justification": "text"
}
OK
GET /api/v3/selectable-integrations HTTP/1.1
Host: api.apono.io
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
OK
{
"data": [
{
"id": "text"
}
],
"pagination": {
"total": 1,
"limit": 1,
"offset": 1
}
}
OK
GET /api/v3/selectable-integrations/{integration_id}/resource-types HTTP/1.1
Host: api.apono.io
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
OK
{
"data": [
{
"id": "text",
"name": "text"
}
],
"pagination": {
"total": 1,
"limit": 1,
"offset": 1
}
}
OK
GET /api/v3/selectable-integrations/{integration_id}/{resource_type}/permissions HTTP/1.1
Host: api.apono.io
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
OK
{
"data": [
"text"
],
"pagination": {
"total": 1,
"limit": 1,
"offset": 1
},
"allow_multiple": true
}
OK
GET /api/v3/selectable-integrations/{integration_id}/{resource_type}/resources HTTP/1.1
Host: api.apono.io
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
OK
{
"data": [
{
"id": "text",
"type": "text",
"name": "text"
}
],
"pagination": {
"total": 1,
"limit": 1,
"offset": 1
}
}
Last updated
Was this helpful?