Bundles

List Bundles

get

Authorizations

Authorization

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Query parameters

limitinteger · int32OptionalDefault: 100

namestring · nullableOptional

Filter bundles by name. Supports wildcard () for partial matches - use * for contains, prefix for starts with, *suffix for ends with

page_tokenstring · nullableOptional

space_referencesstring[] · nullableOptional

List of space IDs or names to filter results by. If omitted, returns objects from all spaces. To return only objects that belong to no space, include the special value "null" in the list

Responses

200

OK

application/json

get

/api/admin/v2/bundles

HTTPcURLJavaScriptPython

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"
          }
        }
      ],
      "space": {
        "space_id": "text",
        "space_name": "text"
      },
      "creation_date": "text",
      "update_date": "text"
    }
  ],
  "pagination": {
    "next_page_token": "text"
  }
}

Create Bundle

post

Authorizations

Authorization

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Query parameters

space_referencestring · nullableOptional

ID or name of the space where to create the resource. If null or empty, the object is created without a space

Body

application/json

namestringRequired

Display name of the bundle

Responses

200

OK

application/json

idstringRequired

Unique identifier of the bundle

namestringRequired

Display name of the bundle

creation_datestring · date-timeRequired

ISO 8601 formatted date-time

update_datestring · date-timeRequired

ISO 8601 formatted date-time

post

/api/admin/v2/bundles

HTTPcURLJavaScriptPython

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"
      }
    }
  ],
  "space": {
    "space_id": "text",
    "space_name": "text"
  },
  "creation_date": "text",
  "update_date": "text"
}

Get Bundle

get

Authorizations

Authorization

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

idstringRequired

Responses

200

OK

application/json

idstringRequired

Unique identifier of the bundle

namestringRequired

Display name of the bundle

creation_datestring · date-timeRequired

ISO 8601 formatted date-time

update_datestring · date-timeRequired

ISO 8601 formatted date-time

get

/api/admin/v2/bundles/{id}

HTTPcURLJavaScriptPython

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"
      }
    }
  ],
  "space": {
    "space_id": "text",
    "space_name": "text"
  },
  "creation_date": "text",
  "update_date": "text"
}

Update Bundle

put

Authorizations

Authorization

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

idstringRequired

Body

application/json

namestringRequired

Display name of the bundle

Responses

200

OK

application/json

idstringRequired

Unique identifier of the bundle

namestringRequired

Display name of the bundle

creation_datestring · date-timeRequired

ISO 8601 formatted date-time

update_datestring · date-timeRequired

ISO 8601 formatted date-time

put

/api/admin/v2/bundles/{id}

HTTPcURLJavaScriptPython

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"
      }
    }
  ],
  "space": {
    "space_id": "text",
    "space_name": "text"
  },
  "creation_date": "text",
  "update_date": "text"
}

Delete Bundle

delete

Authorizations

Authorization

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

idstringRequired

Responses

204

No Content

delete

/api/admin/v2/bundles/{id}

HTTPcURLJavaScriptPython

DELETE /api/admin/v2/bundles/{id} HTTP/1.1
Host: api.apono.io
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

204

No Content

No content

List Access Bundles

get

Authorizations

Authorization

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Responses

200

OK

application/json

get

/api/v1/access-bundles

HTTPcURLJavaScriptPython

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

Authorization

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

application/json

namestringRequired

Responses

200

OK

application/json

idstringRequired

namestringRequired

post

/api/v1/access-bundles

HTTPcURLJavaScriptPython

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

Get Access Bundle

get

Authorizations

Authorization

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

idstringRequired

Responses

200

OK

application/json

idstringRequired

namestringRequired

get

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

HTTPcURLJavaScriptPython

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

Authorization

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

idstringRequired

Responses

200

OK

application/json

messagestringRequired

delete

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

HTTPcURLJavaScriptPython

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

200

OK

{
  "message": "text"
}

Update Access Bundle

patch

Authorizations

Authorization

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

idstringRequired

Body

application/json

namestring · nullableOptional

Responses

200

OK

application/json

idstringRequired

namestringRequired

patch

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

HTTPcURLJavaScriptPython

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