Access Flows
Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Query parameters
limitinteger · int32OptionalDefault:
100page_tokenstring | nullableOptional
Responses
200
OK
application/json
get
/api/admin/v2/access-flowsGET /api/admin/v2/access-flows HTTP/1.1
Host: api.apono.io
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
200
OK
{
"items": [
{
"id": "text",
"name": "text",
"active": true,
"trigger": "text",
"requestors": {
"logical_operator": "text",
"conditions": [
{
"source_integration_id": "text",
"source_integration_name": "text",
"type": "text",
"match_operator": "text",
"values": [
"text"
]
}
]
},
"request_for": {
"request_scopes": [
"text"
],
"grantees": {
"logical_operator": "text",
"conditions": [
{
"source_integration_id": "text",
"source_integration_name": "text",
"type": "text",
"match_operator": "text",
"values": [
"text"
]
}
]
}
},
"access_targets": [
{
"integration": {
"integration_id": "text",
"integration_name": "text",
"resource_type": "text",
"permissions": [
"text"
],
"resources_scopes": [
{
"scope_mode": "text",
"type": "text",
"key": "text",
"values": [
"text"
]
}
]
},
"bundle": {
"bundle_id": "text",
"bundle_name": "text"
},
"access_scope": {
"access_scope_id": "text",
"access_scope_name": "text"
}
}
],
"approver_policy": {
"approval_mode": "text",
"approver_groups": [
{
"logical_operator": "text",
"approvers": [
{
"source_integration_id": "text",
"source_integration_name": "text",
"type": "text",
"match_operator": "text",
"values": [
"text"
]
}
]
}
]
},
"grant_duration_in_min": 1,
"timeframe": {
"start_time": "text",
"end_time": "text",
"days_of_week": [
"MONDAY"
],
"time_zone": "text"
},
"settings": {
"justification_required": true,
"require_approver_reason": true,
"requestor_cannot_approve_himself": true,
"require_mfa": true,
"labels": [
"text"
]
},
"creation_date": {
"0": "2",
"1": "0",
"2": "2",
"3": "5",
"4": "-",
"5": "1",
"6": "1",
"7": "-",
"8": "1",
"9": "3",
"10": "T",
"11": "1",
"12": "4",
"13": ":",
"14": "0",
"15": "7",
"16": ":",
"17": "1",
"18": "2",
"19": ".",
"20": "9",
"21": "3",
"22": "9",
"23": "Z"
},
"update_date": "text"
}
],
"pagination": {
"next_page_token": "text"
}
}Note: Some fields are only applicable in self-serve access flows and are ignored or not required in automatic access flows. Refer to each field’s description to understand when it applies.
Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Body
namestringRequired
Display name of the access flow
activebooleanRequired
Activity state of the access flow (active or inactive)
triggerstringRequired
Event or action that triggers the access flow
request_forall of | nullableOptional
approver_policyall of | nullableOptional
grant_duration_in_mininteger · int32 | nullableOptional
Duration of access granted to the user, in minutes
timeframeall of | nullableOptional
request_for_othersbooleanRequired
Responses
200
OK
application/json
post
/api/admin/v2/access-flowsPOST /api/admin/v2/access-flows HTTP/1.1
Host: api.apono.io
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 1179
{
"name": "text",
"active": true,
"trigger": "text",
"requestors": {
"logical_operator": "text",
"conditions": [
{
"source_integration_reference": "text",
"type": "text",
"match_operator": "text",
"values": [
"text"
]
}
]
},
"request_for": {
"request_scopes": [
"text"
],
"grantees": {
"logical_operator": "text",
"conditions": [
{
"source_integration_reference": "text",
"type": "text",
"match_operator": "text",
"values": [
"text"
]
}
]
}
},
"access_targets": [
{
"integration": {
"integration_reference": "text",
"resource_type": "text",
"permissions": [
"text"
],
"resources_scopes": [
{
"scope_mode": "text",
"type": "text",
"key": "text",
"values": [
"text"
]
}
]
},
"bundle": {
"bundle_reference": "text"
},
"access_scope": {
"access_scope_reference": "text"
}
}
],
"approver_policy": {
"approval_mode": "text",
"approver_groups": [
{
"logical_operator": "text",
"approvers": [
{
"source_integration_reference": "text",
"type": "text",
"match_operator": "text",
"values": [
"text"
]
}
]
}
]
},
"grant_duration_in_min": 1,
"timeframe": {
"start_time": "text",
"end_time": "text",
"days_of_week": [
"MONDAY"
],
"time_zone": "text"
},
"settings": {
"justification_required": true,
"require_approver_reason": true,
"requestor_cannot_approve_himself": true,
"require_mfa": true,
"labels": [
"text"
]
},
"request_for_others": true
}200
OK
{
"id": "text",
"name": "text",
"active": true,
"trigger": "text",
"requestors": {
"logical_operator": "text",
"conditions": [
{
"source_integration_id": "text",
"source_integration_name": "text",
"type": "text",
"match_operator": "text",
"values": [
"text"
]
}
]
},
"request_for": {
"request_scopes": [
"text"
],
"grantees": {
"logical_operator": "text",
"conditions": [
{
"source_integration_id": "text",
"source_integration_name": "text",
"type": "text",
"match_operator": "text",
"values": [
"text"
]
}
]
}
},
"access_targets": [
{
"integration": {
"integration_id": "text",
"integration_name": "text",
"resource_type": "text",
"permissions": [
"text"
],
"resources_scopes": [
{
"scope_mode": "text",
"type": "text",
"key": "text",
"values": [
"text"
]
}
]
},
"bundle": {
"bundle_id": "text",
"bundle_name": "text"
},
"access_scope": {
"access_scope_id": "text",
"access_scope_name": "text"
}
}
],
"approver_policy": {
"approval_mode": "text",
"approver_groups": [
{
"logical_operator": "text",
"approvers": [
{
"source_integration_id": "text",
"source_integration_name": "text",
"type": "text",
"match_operator": "text",
"values": [
"text"
]
}
]
}
]
},
"grant_duration_in_min": 1,
"timeframe": {
"start_time": "text",
"end_time": "text",
"days_of_week": [
"MONDAY"
],
"time_zone": "text"
},
"settings": {
"justification_required": true,
"require_approver_reason": true,
"requestor_cannot_approve_himself": true,
"require_mfa": true,
"labels": [
"text"
]
},
"creation_date": {
"0": "2",
"1": "0",
"2": "2",
"3": "5",
"4": "-",
"5": "1",
"6": "1",
"7": "-",
"8": "1",
"9": "3",
"10": "T",
"11": "1",
"12": "4",
"13": ":",
"14": "0",
"15": "7",
"16": ":",
"17": "1",
"18": "2",
"19": ".",
"20": "9",
"21": "3",
"22": "9",
"23": "Z"
},
"update_date": "text"
}Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
idstringRequired
Responses
200
OK
application/json
get
/api/admin/v2/access-flows/{id}GET /api/admin/v2/access-flows/{id} HTTP/1.1
Host: api.apono.io
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
200
OK
{
"id": "text",
"name": "text",
"active": true,
"trigger": "text",
"requestors": {
"logical_operator": "text",
"conditions": [
{
"source_integration_id": "text",
"source_integration_name": "text",
"type": "text",
"match_operator": "text",
"values": [
"text"
]
}
]
},
"request_for": {
"request_scopes": [
"text"
],
"grantees": {
"logical_operator": "text",
"conditions": [
{
"source_integration_id": "text",
"source_integration_name": "text",
"type": "text",
"match_operator": "text",
"values": [
"text"
]
}
]
}
},
"access_targets": [
{
"integration": {
"integration_id": "text",
"integration_name": "text",
"resource_type": "text",
"permissions": [
"text"
],
"resources_scopes": [
{
"scope_mode": "text",
"type": "text",
"key": "text",
"values": [
"text"
]
}
]
},
"bundle": {
"bundle_id": "text",
"bundle_name": "text"
},
"access_scope": {
"access_scope_id": "text",
"access_scope_name": "text"
}
}
],
"approver_policy": {
"approval_mode": "text",
"approver_groups": [
{
"logical_operator": "text",
"approvers": [
{
"source_integration_id": "text",
"source_integration_name": "text",
"type": "text",
"match_operator": "text",
"values": [
"text"
]
}
]
}
]
},
"grant_duration_in_min": 1,
"timeframe": {
"start_time": "text",
"end_time": "text",
"days_of_week": [
"MONDAY"
],
"time_zone": "text"
},
"settings": {
"justification_required": true,
"require_approver_reason": true,
"requestor_cannot_approve_himself": true,
"require_mfa": true,
"labels": [
"text"
]
},
"creation_date": {
"0": "2",
"1": "0",
"2": "2",
"3": "5",
"4": "-",
"5": "1",
"6": "1",
"7": "-",
"8": "1",
"9": "3",
"10": "T",
"11": "1",
"12": "4",
"13": ":",
"14": "0",
"15": "7",
"16": ":",
"17": "1",
"18": "2",
"19": ".",
"20": "9",
"21": "3",
"22": "9",
"23": "Z"
},
"update_date": "text"
}Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
idstringRequired
Body
namestringRequired
Display name of the access flow
activebooleanRequired
Activity state of the access flow (active or inactive)
triggerstringRequired
Event or action that triggers the access flow
request_forall of | nullableOptional
approver_policyall of | nullableOptional
grant_duration_in_mininteger · int32 | nullableOptional
Duration of access granted to the user, in minutes
timeframeall of | nullableOptional
request_for_othersbooleanRequired
Responses
200
OK
application/json
put
/api/admin/v2/access-flows/{id}PUT /api/admin/v2/access-flows/{id} HTTP/1.1
Host: api.apono.io
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 1179
{
"name": "text",
"active": true,
"trigger": "text",
"requestors": {
"logical_operator": "text",
"conditions": [
{
"source_integration_reference": "text",
"type": "text",
"match_operator": "text",
"values": [
"text"
]
}
]
},
"request_for": {
"request_scopes": [
"text"
],
"grantees": {
"logical_operator": "text",
"conditions": [
{
"source_integration_reference": "text",
"type": "text",
"match_operator": "text",
"values": [
"text"
]
}
]
}
},
"access_targets": [
{
"integration": {
"integration_reference": "text",
"resource_type": "text",
"permissions": [
"text"
],
"resources_scopes": [
{
"scope_mode": "text",
"type": "text",
"key": "text",
"values": [
"text"
]
}
]
},
"bundle": {
"bundle_reference": "text"
},
"access_scope": {
"access_scope_reference": "text"
}
}
],
"approver_policy": {
"approval_mode": "text",
"approver_groups": [
{
"logical_operator": "text",
"approvers": [
{
"source_integration_reference": "text",
"type": "text",
"match_operator": "text",
"values": [
"text"
]
}
]
}
]
},
"grant_duration_in_min": 1,
"timeframe": {
"start_time": "text",
"end_time": "text",
"days_of_week": [
"MONDAY"
],
"time_zone": "text"
},
"settings": {
"justification_required": true,
"require_approver_reason": true,
"requestor_cannot_approve_himself": true,
"require_mfa": true,
"labels": [
"text"
]
},
"request_for_others": true
}200
OK
{
"id": "text",
"name": "text",
"active": true,
"trigger": "text",
"requestors": {
"logical_operator": "text",
"conditions": [
{
"source_integration_id": "text",
"source_integration_name": "text",
"type": "text",
"match_operator": "text",
"values": [
"text"
]
}
]
},
"request_for": {
"request_scopes": [
"text"
],
"grantees": {
"logical_operator": "text",
"conditions": [
{
"source_integration_id": "text",
"source_integration_name": "text",
"type": "text",
"match_operator": "text",
"values": [
"text"
]
}
]
}
},
"access_targets": [
{
"integration": {
"integration_id": "text",
"integration_name": "text",
"resource_type": "text",
"permissions": [
"text"
],
"resources_scopes": [
{
"scope_mode": "text",
"type": "text",
"key": "text",
"values": [
"text"
]
}
]
},
"bundle": {
"bundle_id": "text",
"bundle_name": "text"
},
"access_scope": {
"access_scope_id": "text",
"access_scope_name": "text"
}
}
],
"approver_policy": {
"approval_mode": "text",
"approver_groups": [
{
"logical_operator": "text",
"approvers": [
{
"source_integration_id": "text",
"source_integration_name": "text",
"type": "text",
"match_operator": "text",
"values": [
"text"
]
}
]
}
]
},
"grant_duration_in_min": 1,
"timeframe": {
"start_time": "text",
"end_time": "text",
"days_of_week": [
"MONDAY"
],
"time_zone": "text"
},
"settings": {
"justification_required": true,
"require_approver_reason": true,
"requestor_cannot_approve_himself": true,
"require_mfa": true,
"labels": [
"text"
]
},
"creation_date": {
"0": "2",
"1": "0",
"2": "2",
"3": "5",
"4": "-",
"5": "1",
"6": "1",
"7": "-",
"8": "1",
"9": "3",
"10": "T",
"11": "1",
"12": "4",
"13": ":",
"14": "0",
"15": "7",
"16": ":",
"17": "1",
"18": "2",
"19": ".",
"20": "9",
"21": "3",
"22": "9",
"23": "Z"
},
"update_date": "text"
}Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
idstringRequired
Responses
204
No Content
delete
/api/admin/v2/access-flows/{id}DELETE /api/admin/v2/access-flows/{id} HTTP/1.1
Host: api.apono.io
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
204
No Content
No content
Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Responses
200
OK
application/json
get
/api/v1/access-flowsGET /api/v1/access-flows HTTP/1.1
Host: api.apono.io
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
200
OK
{
"data": [
{
"id": "text",
"name": "text",
"active": true,
"trigger": {
"type": "text",
"timeframe": {
"start_of_day_time_in_seconds": 1,
"end_of_day_time_in_seconds": 1,
"days_in_week": [
"MONDAY"
],
"time_zone": "text"
}
},
"grantees": [
{
"id": "text",
"type": "text"
}
],
"integration_targets": [
{
"integration_id": "text",
"resource_type": "text",
"resource_tag_includes": [
{
"name": "text",
"value": "text"
}
],
"resource_tag_excludes": [
{
"name": "text",
"value": "text"
}
],
"permissions": [
"text"
]
}
],
"bundle_targets": [
{
"bundle_id": "text"
}
],
"approvers": [
{
"id": "text",
"type": "text"
}
],
"revoke_after_in_sec": 1,
"settings": {
"require_justification_on_request_again": true,
"require_all_approvers": true,
"require_approver_justification": true,
"approver_cannot_approve_himself": true
},
"created_date": "{seconds}.{nanos}"
}
],
"pagination": {
"total": 1,
"limit": 1,
"offset": 1
}
}Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Body
namestringRequired
activebooleanRequired
revoke_after_in_secinteger · int32Required
settingsall of | nullableOptional
Responses
200
OK
application/json
post
/api/v1/access-flowsPOST /api/v1/access-flows HTTP/1.1
Host: api.apono.io
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 700
{
"name": "text",
"active": true,
"trigger": {
"type": "text",
"timeframe": {
"start_of_day_time_in_seconds": 1,
"end_of_day_time_in_seconds": 1,
"days_in_week": [
"MONDAY"
],
"time_zone": "text"
}
},
"grantees": [
{
"id": "text",
"type": "text"
}
],
"integration_targets": [
{
"integration_id": "text",
"resource_type": "text",
"resource_tag_includes": [
{
"name": "text",
"value": "text"
}
],
"resource_tag_excludes": [
{
"name": "text",
"value": "text"
}
],
"permissions": [
"text"
]
}
],
"bundle_targets": [
{
"bundle_id": "text"
}
],
"approvers": [
{
"id": "text",
"type": "text"
}
],
"revoke_after_in_sec": 1,
"settings": {
"require_justification_on_request_again": true,
"require_all_approvers": true,
"require_approver_justification": true,
"approver_cannot_approve_himself": true
}
}200
OK
{
"id": "text",
"name": "text",
"active": true,
"trigger": {
"type": "text",
"timeframe": {
"start_of_day_time_in_seconds": 1,
"end_of_day_time_in_seconds": 1,
"days_in_week": [
"MONDAY"
],
"time_zone": "text"
}
},
"grantees": [
{
"id": "text",
"type": "text"
}
],
"integration_targets": [
{
"integration_id": "text",
"resource_type": "text",
"resource_tag_includes": [
{
"name": "text",
"value": "text"
}
],
"resource_tag_excludes": [
{
"name": "text",
"value": "text"
}
],
"permissions": [
"text"
]
}
],
"bundle_targets": [
{
"bundle_id": "text"
}
],
"approvers": [
{
"id": "text",
"type": "text"
}
],
"revoke_after_in_sec": 1,
"settings": {
"require_justification_on_request_again": true,
"require_all_approvers": true,
"require_approver_justification": true,
"approver_cannot_approve_himself": true
},
"created_date": "{seconds}.{nanos}"
}Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
idstringRequired
Responses
200
OK
application/json
get
/api/v1/access-flows/{id}GET /api/v1/access-flows/{id} HTTP/1.1
Host: api.apono.io
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
200
OK
{
"id": "text",
"name": "text",
"active": true,
"trigger": {
"type": "text",
"timeframe": {
"start_of_day_time_in_seconds": 1,
"end_of_day_time_in_seconds": 1,
"days_in_week": [
"MONDAY"
],
"time_zone": "text"
}
},
"grantees": [
{
"id": "text",
"type": "text"
}
],
"integration_targets": [
{
"integration_id": "text",
"resource_type": "text",
"resource_tag_includes": [
{
"name": "text",
"value": "text"
}
],
"resource_tag_excludes": [
{
"name": "text",
"value": "text"
}
],
"permissions": [
"text"
]
}
],
"bundle_targets": [
{
"bundle_id": "text"
}
],
"approvers": [
{
"id": "text",
"type": "text"
}
],
"revoke_after_in_sec": 1,
"settings": {
"require_justification_on_request_again": true,
"require_all_approvers": true,
"require_approver_justification": true,
"approver_cannot_approve_himself": true
},
"created_date": "{seconds}.{nanos}"
}Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
idstringRequired
Responses
200
OK
application/json
delete
/api/v1/access-flows/{id}DELETE /api/v1/access-flows/{id} HTTP/1.1
Host: api.apono.io
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
200
OK
{
"message": "text"
}Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
idstringRequired
Body
namestring | nullableOptional
activeboolean | nullableOptional
triggerall of | nullableOptional
revoke_after_in_secinteger · int32 | nullableOptional
settingsall of | nullableOptional
Responses
200
OK
application/json
patch
/api/v1/access-flows/{id}PATCH /api/v1/access-flows/{id} HTTP/1.1
Host: api.apono.io
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 700
{
"name": "text",
"active": true,
"trigger": {
"type": "text",
"timeframe": {
"start_of_day_time_in_seconds": 1,
"end_of_day_time_in_seconds": 1,
"days_in_week": [
"MONDAY"
],
"time_zone": "text"
}
},
"grantees": [
{
"id": "text",
"type": "text"
}
],
"integration_targets": [
{
"integration_id": "text",
"resource_type": "text",
"resource_tag_includes": [
{
"name": "text",
"value": "text"
}
],
"resource_tag_excludes": [
{
"name": "text",
"value": "text"
}
],
"permissions": [
"text"
]
}
],
"bundle_targets": [
{
"bundle_id": "text"
}
],
"approvers": [
{
"id": "text",
"type": "text"
}
],
"revoke_after_in_sec": 1,
"settings": {
"require_justification_on_request_again": true,
"require_all_approvers": true,
"require_approver_justification": true,
"approver_cannot_approve_himself": true
}
}200
OK
{
"id": "text",
"name": "text",
"active": true,
"trigger": {
"type": "text",
"timeframe": {
"start_of_day_time_in_seconds": 1,
"end_of_day_time_in_seconds": 1,
"days_in_week": [
"MONDAY"
],
"time_zone": "text"
}
},
"grantees": [
{
"id": "text",
"type": "text"
}
],
"integration_targets": [
{
"integration_id": "text",
"resource_type": "text",
"resource_tag_includes": [
{
"name": "text",
"value": "text"
}
],
"resource_tag_excludes": [
{
"name": "text",
"value": "text"
}
],
"permissions": [
"text"
]
}
],
"bundle_targets": [
{
"bundle_id": "text"
}
],
"approvers": [
{
"id": "text",
"type": "text"
}
],
"revoke_after_in_sec": 1,
"settings": {
"require_justification_on_request_again": true,
"require_all_approvers": true,
"require_approver_justification": true,
"approver_cannot_approve_himself": true
},
"created_date": "{seconds}.{nanos}"
}Last updated
Was this helpful?