LogoLogo
API Reference
API Reference
  • API OVERVIEW
    • Getting Started with the Apono API
    • API Authentication
  • New Endpoints
  • APONO
    • Groups
    • Access Flows
    • Bundles
    • Connectors
    • Users
    • Integrations
    • Access Sessions
    • Available Access
    • Access Requests
    • Access Bundles
    • Identities
    • Activity
    • Access Scopes
Powered by GitBook
On this page

Was this helpful?

Export as PDF
  1. APONO

Access Scopes

PreviousActivity

Last updated 1 month ago

Was this helpful?

Get Access Scope

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

OK

{
  "id": "text",
  "name": "text",
  "query": "text",
  "creation_date": "text",
  "update_date": "text"
}

Delete Access Scope

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

No Content

No content
  • GETList Access Scopes
  • POSTCreate Access Scope
  • GETGet Access Scope
  • PUTUpdate Access Scope
  • DELETEDelete Access Scope

List Access Scopes

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

OK

{
  "items": [
    {
      "id": "text",
      "name": "text",
      "query": "text",
      "creation_date": "text",
      "update_date": "text"
    }
  ],
  "pagination": {
    "next_page_token": "text"
  }
}

Create Access Scope

post
Authorizations
Body
namestringRequired

Display name of the access scope

querystringRequired

Apono Query Language (AQL) expression that defines filters for cloud resources, integrations, and permissions

Responses
200
OK
application/json
post
POST /api/admin/v1/access-scopes HTTP/1.1
Host: api.apono.io
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 30

{
  "name": "text",
  "query": "text"
}
200

OK

{
  "id": "text",
  "name": "text",
  "query": "text",
  "creation_date": "text",
  "update_date": "text"
}

Update Access Scope

put
Authorizations
Path parameters
idstringRequired
Body
namestringRequired

Display name of the access scope

querystringRequired

Apono Query Language (AQL) expression that defines filters for cloud resources, integrations, and permissions

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

{
  "name": "text",
  "query": "text"
}
200

OK

{
  "id": "text",
  "name": "text",
  "query": "text",
  "creation_date": "text",
  "update_date": "text"
}