LogoLogo
API Reference
API Reference
  • API OVERVIEW
    • Getting started using Apono API
    • API Authentication
  • New Endpoints (Beta)
  • APONO
    • Groups
    • Access Flows
    • Bundles
    • Connectors
    • Users
    • Integrations
    • Access Bundles
    • Identities
    • Access Requests
    • Activity
    • Access Scopes
Powered by GitBook
On this page

Was this helpful?

Export as PDF
  1. APONO

Bundles

PreviousAccess FlowsNextConnectors

Last updated 15 days ago

Was this helpful?

Get Bundle

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

OK

{
  "id": "text",
  "name": "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"
            ]
          }
        ]
      },
      "access_scope": {
        "access_scope_id": "text",
        "access_scope_name": "text"
      }
    }
  ],
  "creation_date": "text",
  "update_date": "text"
}

Delete Bundle

delete
Authorizations
Path parameters
idstringRequired
Responses
204
No Content
delete
DELETE /api/admin/v2/bundles/{id} HTTP/1.1
Host: api.apono.io
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
204

No Content

No content
  • GETList Bundles
  • POSTCreate Bundle
  • GETGet Bundle
  • PUTUpdate Bundle
  • DELETEDelete Bundle

List Bundles

get
Authorizations
Query parameters
limitinteger ยท int32OptionalDefault: 100
namestring | nullableOptional
page_tokenstring | nullableOptional
Responses
200
OK
application/json
get
GET /api/admin/v2/bundles HTTP/1.1
Host: api.apono.io
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
200

OK

{
  "items": [
    {
      "id": "text",
      "name": "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"
                ]
              }
            ]
          },
          "access_scope": {
            "access_scope_id": "text",
            "access_scope_name": "text"
          }
        }
      ],
      "creation_date": "text",
      "update_date": "text"
    }
  ],
  "pagination": {
    "next_page_token": "text"
  }
}

Create Bundle

post
Authorizations
Body
namestringRequired

Display name of the bundle

Responses
200
OK
application/json
post
POST /api/admin/v2/bundles HTTP/1.1
Host: api.apono.io
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 266

{
  "name": "text",
  "access_targets": [
    {
      "integration": {
        "integration_reference": "text",
        "resource_type": "text",
        "permissions": [
          "text"
        ],
        "resources_scopes": [
          {
            "scope_mode": "text",
            "type": "text",
            "key": "text",
            "values": [
              "text"
            ]
          }
        ]
      },
      "access_scope": {
        "access_scope_reference": "text"
      }
    }
  ]
}
200

OK

{
  "id": "text",
  "name": "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"
            ]
          }
        ]
      },
      "access_scope": {
        "access_scope_id": "text",
        "access_scope_name": "text"
      }
    }
  ],
  "creation_date": "text",
  "update_date": "text"
}

Update Bundle

put
Authorizations
Path parameters
idstringRequired
Body
namestringRequired

Display name of the bundle

Responses
200
OK
application/json
put
PUT /api/admin/v2/bundles/{id} HTTP/1.1
Host: api.apono.io
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 266

{
  "name": "text",
  "access_targets": [
    {
      "integration": {
        "integration_reference": "text",
        "resource_type": "text",
        "permissions": [
          "text"
        ],
        "resources_scopes": [
          {
            "scope_mode": "text",
            "type": "text",
            "key": "text",
            "values": [
              "text"
            ]
          }
        ]
      },
      "access_scope": {
        "access_scope_reference": "text"
      }
    }
  ]
}
200

OK

{
  "id": "text",
  "name": "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"
            ]
          }
        ]
      },
      "access_scope": {
        "access_scope_id": "text",
        "access_scope_name": "text"
      }
    }
  ],
  "creation_date": "text",
  "update_date": "text"
}