Access Flows

List Access Flows

GEThttps://api.apono.io/api/v1/access-flows

Response

Body

data*array of AccessFlowV1 (object)

pagination*PaginationInfo (object)

Request

const response = await fetch('https://api.apono.io/api/v1/access-flows', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

{
  "data": [
    {
      "id": "text",
      "name": "text",
      "active": false,
      "trigger": {
        "type": "text",
        "timeframe": {
          "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"
        }
      ],
      "settings": {
        "require_justification_on_request_again": false,
        "require_all_approvers": false,
        "require_approver_justification": false,
        "approver_cannot_approve_himself": false
      },
      "created_date": "{seconds}.{nanos}"
    }
  ],
  "pagination": {}
}

Create Access Flow

POSThttps://api.apono.io/api/v1/access-flows

Body

name*string

active*boolean

trigger*AccessFlowTriggerV1 (object)

grantees*array of GranteeV1 (object)

integration_targetsnullable array of AccessTargetIntegrationV1 (object)

bundle_targetsnullable array of AccessTargetBundleV1 (object)

approversnullable array of ApproverV1 (object)

revoke_after_in_sec*integer (int32)

settingsnullable object

Response

Body

id*string

name*string

active*boolean

trigger*AccessFlowTriggerV1 (object)

grantees*array of GranteeV1 (object)

integration_targets*array of AccessTargetIntegrationV1 (object)

bundle_targets*array of AccessTargetBundleV1 (object)

approversnullable array of ApproverV1 (object)

revoke_after_in_sec*integer (int32)

settingsnullable object

created_date*Instant (number (double))

Example: "{seconds}.{nanos}"

Request

const response = await fetch('https://api.apono.io/api/v1/access-flows', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "name": "text",
      "active": false,
      "trigger": {
        "type": "text"
      },
      "grantees": [
        {
          "id": "text",
          "type": "text"
        }
      ]
    }),
});
const data = await response.json();

Response

{
  "id": "text",
  "name": "text",
  "active": false,
  "trigger": {
    "type": "text",
    "timeframe": {
      "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"
    }
  ],
  "settings": {
    "require_justification_on_request_again": false,
    "require_all_approvers": false,
    "require_approver_justification": false,
    "approver_cannot_approve_himself": false
  },
  "created_date": "{seconds}.{nanos}"
}

Get Access Flow

GEThttps://api.apono.io/api/v1/access-flows/{id}

Path parameters

id*string

Response

Body

id*string

name*string

active*boolean

trigger*AccessFlowTriggerV1 (object)

grantees*array of GranteeV1 (object)

integration_targets*array of AccessTargetIntegrationV1 (object)

bundle_targets*array of AccessTargetBundleV1 (object)

approversnullable array of ApproverV1 (object)

revoke_after_in_sec*integer (int32)

settingsnullable object

created_date*Instant (number (double))

Example: "{seconds}.{nanos}"

Request

const response = await fetch('https://api.apono.io/api/v1/access-flows/{id}', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

{
  "id": "text",
  "name": "text",
  "active": false,
  "trigger": {
    "type": "text",
    "timeframe": {
      "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"
    }
  ],
  "settings": {
    "require_justification_on_request_again": false,
    "require_all_approvers": false,
    "require_approver_justification": false,
    "approver_cannot_approve_himself": false
  },
  "created_date": "{seconds}.{nanos}"
}

Delete Access Flow

DELETEhttps://api.apono.io/api/v1/access-flows/{id}

Path parameters

id*string

Response

Body

message*string

Request

const response = await fetch('https://api.apono.io/api/v1/access-flows/{id}', {
    method: 'DELETE',
    headers: {},
});
const data = await response.json();

Response

{
  "message": "text"
}

Update Access Flow

PATCHhttps://api.apono.io/api/v1/access-flows/{id}

Path parameters

id*string

Body

namenullable string

activenullable boolean

triggernullable object

granteesnullable array of GranteeV1 (object)

integration_targetsnullable array of AccessTargetIntegrationV1 (object)

bundle_targetsnullable array of AccessTargetBundleV1 (object)

approversnullable array of ApproverV1 (object)

revoke_after_in_secnullable integer (int32)

settingsnullable object

Response

Body

id*string

name*string

active*boolean

trigger*AccessFlowTriggerV1 (object)

grantees*array of GranteeV1 (object)

integration_targets*array of AccessTargetIntegrationV1 (object)

bundle_targets*array of AccessTargetBundleV1 (object)

approversnullable array of ApproverV1 (object)

revoke_after_in_sec*integer (int32)

settingsnullable object

created_date*Instant (number (double))

Example: "{seconds}.{nanos}"

Request

const response = await fetch('https://api.apono.io/api/v1/access-flows/{id}', {
    method: 'PATCH',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

{
  "id": "text",
  "name": "text",
  "active": false,
  "trigger": {
    "type": "text",
    "timeframe": {
      "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"
    }
  ],
  "settings": {
    "require_justification_on_request_again": false,
    "require_all_approvers": false,
    "require_approver_justification": false,
    "approver_cannot_approve_himself": false
  },
  "created_date": "{seconds}.{nanos}"
}

PreviousAccess Bundles NextConnectors

Last updated 2 months ago

const response = await fetch('https://api.apono.io/api/v1/access-flows/{id}', { method: 'PATCH', headers: { "Content-Type": "application/json" }, body: JSON.stringify({}), }); const data = await response.json();

{ "id": "text", "name": "text", "active": false, "trigger": { "type": "text", "timeframe": { "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" } ], "settings": { "require_justification_on_request_again": false, "require_all_approvers": false, "require_approver_justification": false, "approver_cannot_approve_himself": false }, "created_date": "{seconds}.{nanos}" }

const response = await fetch('https://api.apono.io/api/v1/access-flows', { method: 'POST', headers: { "Content-Type": "application/json" }, body: JSON.stringify({ "name": "text", "active": false, "trigger": { "type": "text" }, "grantees": [ { "id": "text", "type": "text" } ] }), }); const data = await response.json();