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

Users

PreviousConnectorsNextIntegrations

Last updated 15 days ago

Was this helpful?

List Users

get
Authorizations
Query parameters
first_namestring | nullableOptional
last_namestring | nullableOptional
limitinteger ยท int32OptionalDefault: 100
page_tokenstring | nullableOptional
rolestring[] | nullableOptional
source_integration_idstring | nullableOptional
source_integration_namestring | nullableOptional
Responses
200
OK
application/json
get
GET /api/admin/v3/users HTTP/1.1
Host: api.apono.io
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
200

OK

{
  "items": [
    {
      "id": "text",
      "email": "text",
      "email_aliases": [
        "text"
      ],
      "first_name": "text",
      "last_name": "text",
      "active": true,
      "roles": [
        "text"
      ],
      "source_integration_id": "text",
      "source_integration_name": "text",
      "attributes": {
        "ANY_ADDITIONAL_PROPERTY": "text"
      }
    }
  ],
  "pagination": {
    "next_page_token": "text"
  }
}

Get User

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

OK

{
  "id": "text",
  "email": "text",
  "email_aliases": [
    "text"
  ],
  "first_name": "text",
  "last_name": "text",
  "active": true,
  "roles": [
    "text"
  ],
  "source_integration_id": "text",
  "source_integration_name": "text",
  "attributes": {
    "ANY_ADDITIONAL_PROPERTY": "text"
  }
}

list users

get
Authorizations
Responses
200
OK
application/json
get
GET /api/v2/users HTTP/1.1
Host: api.apono.io
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
200

OK

{
  "data": [
    {
      "id": "text",
      "email": "text",
      "first_name": "text",
      "last_name": "text",
      "active": true
    }
  ],
  "pagination": {
    "total": 1,
    "limit": 1,
    "offset": 1
  }
}

get user by Id or Email

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

OK

{
  "id": "text",
  "email": "text",
  "first_name": "text",
  "last_name": "text",
  "active": true
}
  • GETList Users
  • GETGet User
  • GETlist users
  • GETget user by Id or Email