Access Flows

List Access Flows

get

Authorizations

Query parameters

limitinteger · int32OptionalDefault: 100

page_tokenstring | nullableOptional

Responses

200

OK

application/json

get

HTTPcURLJavaScriptPython

GET /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"
            ]
          }
        ]
      },
      "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": "7",
        "7": "-",
        "8": "1",
        "9": "2",
        "10": "T",
        "11": "0",
        "12": "8",
        "13": ":",
        "14": "0",
        "15": "2",
        "16": ":",
        "17": "1",
        "18": "4",
        "19": ".",
        "20": "4",
        "21": "8",
        "22": "9",
        "23": "Z"
      },
      "update_date": "text"
    }
  ],
  "pagination": {
    "next_page_token": "text"
  }
}

Create Access Flow

post

Authorizations

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

approver_policyall of | nullableOptional

grant_duration_in_mininteger · int32 | nullableOptional

Duration of access granted to the user, in minutes

timeframeall of | nullableOptional

Responses

200

OK

application/json

post

HTTPcURLJavaScriptPython

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

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"
        ]
      }
    ]
  },
  "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": "7",
    "7": "-",
    "8": "1",
    "9": "2",
    "10": "T",
    "11": "0",
    "12": "8",
    "13": ":",
    "14": "0",
    "15": "2",
    "16": ":",
    "17": "1",
    "18": "4",
    "19": ".",
    "20": "4",
    "21": "8",
    "22": "9",
    "23": "Z"
  },
  "update_date": "text"
}

Get Access Flow

get

Authorizations

Path parameters

idstringRequired

Responses

200

OK

application/json

get

HTTPcURLJavaScriptPython

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"
        ]
      }
    ]
  },
  "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": "7",
    "7": "-",
    "8": "1",
    "9": "2",
    "10": "T",
    "11": "0",
    "12": "8",
    "13": ":",
    "14": "0",
    "15": "2",
    "16": ":",
    "17": "1",
    "18": "4",
    "19": ".",
    "20": "4",
    "21": "8",
    "22": "9",
    "23": "Z"
  },
  "update_date": "text"
}

Update Access Flow

put

Authorizations

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

approver_policyall of | nullableOptional

grant_duration_in_mininteger · int32 | nullableOptional

Duration of access granted to the user, in minutes

timeframeall of | nullableOptional

Responses

200

OK

application/json

put

HTTPcURLJavaScriptPython

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

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"
        ]
      }
    ]
  },
  "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": "7",
    "7": "-",
    "8": "1",
    "9": "2",
    "10": "T",
    "11": "0",
    "12": "8",
    "13": ":",
    "14": "0",
    "15": "2",
    "16": ":",
    "17": "1",
    "18": "4",
    "19": ".",
    "20": "4",
    "21": "8",
    "22": "9",
    "23": "Z"
  },
  "update_date": "text"
}

Delete Access Flow

delete

Authorizations

Path parameters

idstringRequired

Responses

204

No Content

delete

HTTPcURLJavaScriptPython

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

List Access Flows

get

Authorizations

Responses

200

OK

application/json

get

HTTPcURLJavaScriptPython

GET /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
  }
}

Create Access Flow

post

Authorizations

Body

namestringRequired

activebooleanRequired

revoke_after_in_secinteger · int32Required

settingsall of | nullableOptional

Responses

200

OK

application/json

post

HTTPcURLJavaScriptPython

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

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

Get Access Flow

get

Authorizations

Path parameters

idstringRequired

Responses

200

OK

application/json

get

HTTPcURLJavaScriptPython

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

Delete Access Flow

delete

Authorizations

Path parameters

idstringRequired

Responses

200

OK

application/json

delete

HTTPcURLJavaScriptPython

DELETE /api/v1/access-flows/{id} HTTP/1.1
Host: api.apono.io
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200

OK

{
  "message": "text"
}

Update Access Flow

patch

Authorizations

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

HTTPcURLJavaScriptPython

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