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

Groups

PreviousNew EndpointsNextAccess Flows

Last updated 1 month ago

Was this helpful?

Get Group

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

OK

{
  "id": "text",
  "name": "text",
  "source_id": "text",
  "source_integration_id": "text",
  "source_integration_name": "text"
}

Delete Group

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

No Content

No content

Get Group Members

get
Authorizations
Path parameters
idstringRequired
Query parameters
limitinteger · int32OptionalDefault: 100
page_tokenstring | nullableOptional
Responses
200
OK
application/json
get
GET /api/admin/v1/groups/{id}/members HTTP/1.1
Host: api.apono.io
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
200

OK

{
  "items": [
    {
      "email": "text"
    }
  ],
  "pagination": {
    "next_page_token": "text"
  }
}

Add Group Member

put
Authorizations
Path parameters
emailstringRequired
idstringRequired
Responses
204
No Content
put
PUT /api/admin/v1/groups/{id}/members/{email} HTTP/1.1
Host: api.apono.io
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
204

No Content

No content

Remove Group Member

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

No Content

No content
  • GETList Groups
  • POSTCreate Group
  • GETGet Group
  • DELETEDelete Group
  • GETGet Group Members
  • PUTUpdate Group Members
  • PUTAdd Group Member
  • DELETERemove Group Member
  • PUTUpdate Group

List Groups

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

OK

{
  "items": [
    {
      "id": "text",
      "name": "text",
      "source_id": "text",
      "source_integration_id": "text",
      "source_integration_name": "text"
    }
  ],
  "pagination": {
    "next_page_token": "text"
  }
}

Create Group

post
Authorizations
Body
namestringRequired

Display name of the group

members_emailsstring[]Required

Email addresses to assign as members of the group

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

{
  "name": "text",
  "members_emails": [
    "text"
  ]
}
200

OK

{
  "id": "text",
  "name": "text",
  "source_id": "text",
  "source_integration_id": "text",
  "source_integration_name": "text"
}

Update Group Members

put
Authorizations
Path parameters
idstringRequired
Body
members_emailsstring[]Required

Email addresses to assign as members of the group

Responses
204
No Content
put
PUT /api/admin/v1/groups/{id}/members HTTP/1.1
Host: api.apono.io
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 27

{
  "members_emails": [
    "text"
  ]
}
204

No Content

No content

Update Group

put
Authorizations
Path parameters
idstringRequired
Body
namestringRequired

Display name of the group

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

{
  "name": "text"
}
200

OK

{
  "id": "text",
  "name": "text",
  "source_id": "text",
  "source_integration_id": "text",
  "source_integration_name": "text"
}