Access Flows
Last updated
Was this helpful?
API Reference
Last updated
Was this helpful?
GET /api/admin/v2/access-flows/{id} HTTP/1.1
Host: api.apono.io
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
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"
]
}
]
},
"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": "0",
"6": "5",
"7": "-",
"8": "3",
"9": "1",
"10": "T",
"11": "0",
"12": "2",
"13": ":",
"14": "4",
"15": "4",
"16": ":",
"17": "2",
"18": "0",
"19": ".",
"20": "8",
"21": "8",
"22": "9",
"23": "Z"
},
"update_date": "text"
}GET /api/v1/access-flows HTTP/1.1
Host: api.apono.io
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
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
}
}GET /api/v1/access-flows/{id} HTTP/1.1
Host: api.apono.io
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
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}"
}100GET /api/admin/v2/access-flows HTTP/1.1
Host: api.apono.io
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
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"
]
}
]
},
"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": "0",
"6": "5",
"7": "-",
"8": "3",
"9": "1",
"10": "T",
"11": "0",
"12": "2",
"13": ":",
"14": "4",
"15": "4",
"16": ":",
"17": "2",
"18": "0",
"19": ".",
"20": "8",
"21": "8",
"22": "9",
"23": "Z"
},
"update_date": "text"
}
],
"pagination": {
"next_page_token": "text"
}
}Display name of the access flow
Activity state of the access flow (active or inactive)
Event or action that triggers the access flow
Duration of access granted to the user, in minutes
POST /api/admin/v2/access-flows HTTP/1.1
Host: api.apono.io
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 961
{
"name": "text",
"active": true,
"trigger": "text",
"requestors": {
"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"
]
}
}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"
]
}
]
},
"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": "0",
"6": "5",
"7": "-",
"8": "3",
"9": "1",
"10": "T",
"11": "0",
"12": "2",
"13": ":",
"14": "4",
"15": "4",
"16": ":",
"17": "2",
"18": "0",
"19": ".",
"20": "8",
"21": "8",
"22": "9",
"23": "Z"
},
"update_date": "text"
}Display name of the access flow
Activity state of the access flow (active or inactive)
Event or action that triggers the access flow
Duration of access granted to the user, in minutes
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: 961
{
"name": "text",
"active": true,
"trigger": "text",
"requestors": {
"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"
]
}
}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"
]
}
]
},
"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": "0",
"6": "5",
"7": "-",
"8": "3",
"9": "1",
"10": "T",
"11": "0",
"12": "2",
"13": ":",
"14": "4",
"15": "4",
"16": ":",
"17": "2",
"18": "0",
"19": ".",
"20": "8",
"21": "8",
"22": "9",
"23": "Z"
},
"update_date": "text"
}POST /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
}
}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}"
}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
}
}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}"
}