Access Flows

PreviousAccess Bundles NextIdentities

Last updated 3 months ago

Was this helpful?

List Access Flows

get

/api/v1/access-flows

Authorizations

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url 'https://api.apono.io/api/v1/access-flows' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN'

200

{
  "pagination": {
    "total": 1,
    "limit": 1,
    "offset": 1
  },
  "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,
          "time_zone": "text",
          "days_in_week": [
            "MONDAY"
          ]
        }
      },
      "revoke_after_in_sec": 1,
      "created_date": "{seconds}.{nanos}",
      "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"
        }
      ],
      "settings": {
        "require_justification_on_request_again": true,
        "require_all_approvers": true,
        "require_approver_justification": true,
        "approver_cannot_approve_himself": true
      }
    }
  ]
}

Create Access Flow

post

/api/v1/access-flows

Authorizations

Body

namestringrequired

activebooleanrequired

triggerobjectrequired

revoke_after_in_secinteger · int32required

granteesobject[]required

integration_targetsobject[] | nullable

bundle_targetsobject[] | nullable

approversobject[] | nullable

settingsobject | nullable

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url 'https://api.apono.io/api/v1/access-flows' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN' \
  --header 'Content-Type: application/json' \
  --data '{"name":"text","active":true,"trigger":{"type":"text","timeframe":{"start_of_day_time_in_seconds":1,"end_of_day_time_in_seconds":1,"time_zone":"text","days_in_week":["MONDAY"]}},"revoke_after_in_sec":1,"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":[null]}],"bundle_targets":[{"bundle_id":"text"}],"approvers":[{"id":"text","type":"text"}],"settings":{}}'

200

{
  "id": "text",
  "name": "text",
  "active": true,
  "trigger": {
    "type": "text",
    "timeframe": {
      "start_of_day_time_in_seconds": 1,
      "end_of_day_time_in_seconds": 1,
      "time_zone": "text",
      "days_in_week": [
        "MONDAY"
      ]
    }
  },
  "revoke_after_in_sec": 1,
  "created_date": "{seconds}.{nanos}",
  "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"
    }
  ],
  "settings": {
    "require_justification_on_request_again": true,
    "require_all_approvers": true,
    "require_approver_justification": true,
    "approver_cannot_approve_himself": true
  }
}

Get Access Flow

get

/api/v1/access-flows/{id}

Authorizations

Path parameters

idstringrequired

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url 'https://api.apono.io/api/v1/access-flows/{id}' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN'

200

{
  "id": "text",
  "name": "text",
  "active": true,
  "trigger": {
    "type": "text",
    "timeframe": {
      "start_of_day_time_in_seconds": 1,
      "end_of_day_time_in_seconds": 1,
      "time_zone": "text",
      "days_in_week": [
        "MONDAY"
      ]
    }
  },
  "revoke_after_in_sec": 1,
  "created_date": "{seconds}.{nanos}",
  "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"
    }
  ],
  "settings": {
    "require_justification_on_request_again": true,
    "require_all_approvers": true,
    "require_approver_justification": true,
    "approver_cannot_approve_himself": true
  }
}

Delete Access Flow

delete

/api/v1/access-flows/{id}

Authorizations

Path parameters

idstringrequired

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request DELETE \
  --url 'https://api.apono.io/api/v1/access-flows/{id}' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN'

200

{
  "message": "text"
}

Update Access Flow

patch

/api/v1/access-flows/{id}

Authorizations

Path parameters

idstringrequired

Body

namestring | nullable

activeboolean | nullable

revoke_after_in_secinteger · int32 | nullable

granteesobject[] | nullable

integration_targetsobject[] | nullable

bundle_targetsobject[] | nullable

approversobject[] | nullable

triggerobject | nullable

settingsobject | nullable

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request PATCH \
  --url 'https://api.apono.io/api/v1/access-flows/{id}' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN' \
  --header 'Content-Type: application/json' \
  --data '{"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":[null]}],"bundle_targets":[{"bundle_id":"text"}],"approvers":[{"id":"text","type":"text"}],"trigger":{"type":"text","timeframe":{"start_of_day_time_in_seconds":1,"end_of_day_time_in_seconds":1,"time_zone":"text","days_in_week":["MONDAY"]}},"settings":{}}'

200

{
  "id": "text",
  "name": "text",
  "active": true,
  "trigger": {
    "type": "text",
    "timeframe": {
      "start_of_day_time_in_seconds": 1,
      "end_of_day_time_in_seconds": 1,
      "time_zone": "text",
      "days_in_week": [
        "MONDAY"
      ]
    }
  },
  "revoke_after_in_sec": 1,
  "created_date": "{seconds}.{nanos}",
  "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"
    }
  ],
  "settings": {
    "require_justification_on_request_again": true,
    "require_all_approvers": true,
    "require_approver_justification": true,
    "approver_cannot_approve_himself": true
  }
}