LogoLogo
API Reference
API Reference
  • API OVERVIEW
    • Getting started using Apono API
    • API Authentication
  • APONO
    • Access Bundles
    • Access Flows
    • Identities
    • Connectors
    • Integrations
    • Users
    • Access Requests
    • Activity
Powered by GitBook
On this page

Was this helpful?

Export as PDF
  1. APONO

Access Bundles

PreviousAPI AuthenticationNextAccess Flows

Last updated 6 months ago

Was this helpful?

Get Access Bundle

get
Authorizations
Path parameters
idstringRequired
Responses
200
OK
application/json
get
GET /api/v1/access-bundles/{id} HTTP/1.1
Host: api.apono.io
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
200

OK

{
  "id": "text",
  "name": "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"
      ]
    }
  ]
}

Delete Access Bundle

delete
Authorizations
Path parameters
idstringRequired
Responses
200
OK
application/json
delete
DELETE /api/v1/access-bundles/{id} HTTP/1.1
Host: api.apono.io
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
200

OK

{
  "message": "text"
}
  • GETList Access Bundles
  • POSTCreate Access Bundle
  • GETGet Access Bundle
  • DELETEDelete Access Bundle
  • PATCHUpdate Access Bundle

List Access Bundles

get
Authorizations
Responses
200
OK
application/json
get
GET /api/v1/access-bundles HTTP/1.1
Host: api.apono.io
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
200

OK

{
  "data": [
    {
      "id": "text",
      "name": "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"
          ]
        }
      ]
    }
  ],
  "pagination": {
    "total": 1,
    "limit": 1,
    "offset": 1
  }
}

Create Access Bundle

post
Authorizations
Body
namestringRequired
Responses
200
OK
application/json
post
POST /api/v1/access-bundles HTTP/1.1
Host: api.apono.io
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 225

{
  "name": "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"
      ]
    }
  ]
}
200

OK

{
  "id": "text",
  "name": "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"
      ]
    }
  ]
}

Update Access Bundle

patch
Authorizations
Path parameters
idstringRequired
Body
namestring | nullableOptional
Responses
200
OK
application/json
patch
PATCH /api/v1/access-bundles/{id} HTTP/1.1
Host: api.apono.io
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 225

{
  "name": "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"
      ]
    }
  ]
}
200

OK

{
  "id": "text",
  "name": "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"
      ]
    }
  ]
}