Groups

List Groups

get

Authorizations

Authorization

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Query parameters

limitinteger · int32OptionalDefault: 100

namestring · nullableOptional

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

page_tokenstring · nullableOptional

Responses

200

OK

application/json

get/api/admin/v1/groups

HTTPcURLJavaScriptPython

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

Authorization

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

application/json

namestringRequired

Display name of the group

members_emailsstring[]Required

Email addresses to assign as members of the group

Responses

200

OK

application/json

idstringRequired

Unique identifier of the group

namestringRequired

Display name of the group

source_idstring · nullableOptional

Identifier of the group in the integration system providing the entity

source_integration_idstring · nullableOptional

Unique Apono identifier of the integration providing the entity

source_integration_namestring · nullableOptional

Display name of the integration providing the entity

post/api/admin/v1/groups

HTTPcURLJavaScriptPython

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

Get Group

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 group

namestringRequired

Display name of the group

source_idstring · nullableOptional

Identifier of the group in the integration system providing the entity

source_integration_idstring · nullableOptional

Unique Apono identifier of the integration providing the entity

source_integration_namestring · nullableOptional

Display name of the integration providing the entity

get/api/admin/v1/groups/{id}

HTTPcURLJavaScriptPython

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

Authorization

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

idstringRequired

Responses

204

No Content

No content

delete/api/admin/v1/groups/{id}

HTTPcURLJavaScriptPython

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

Authorization

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

idstringRequired

Query parameters

limitinteger · int32OptionalDefault: 100

page_tokenstring · nullableOptional

Responses

200

OK

application/json

get/api/admin/v1/groups/{id}/members

HTTPcURLJavaScriptPython

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

Update Group Members

put

Authorizations

Authorization

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

idstringRequired

Body

application/json

members_emailsstring[]Required

Email addresses to assign as members of the group

Responses

204

No Content

No content

put/api/admin/v1/groups/{id}/members

HTTPcURLJavaScriptPython

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

Add Group Member

put

Authorizations

Authorization

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

emailstringRequired

idstringRequired

Responses

204

No Content

No content

put/api/admin/v1/groups/{id}/members/{email}

HTTPcURLJavaScriptPython

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

Authorization

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

emailstringRequired

idstringRequired

Responses

204

No Content

No content

delete/api/admin/v1/groups/{id}/members/{email}

HTTPcURLJavaScriptPython

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

Update Group

put

Authorizations

Authorization

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

idstringRequired

Body

application/json

namestringRequired

Display name of the group

Responses

200

OK

application/json

idstringRequired

Unique identifier of the group

namestringRequired

Display name of the group

source_idstring · nullableOptional

Identifier of the group in the integration system providing the entity

source_integration_idstring · nullableOptional

Unique Apono identifier of the integration providing the entity

source_integration_namestring · nullableOptional

Display name of the integration providing the entity

put/api/admin/v1/groups/{id}/name

HTTPcURLJavaScriptPython

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