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

Identities

PreviousAccess BundlesNextActivity

Last updated 7 months ago

Was this helpful?

list identities, grantees and approvers

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

OK

{
  "data": [
    {
      "type": "text",
      "name": "text",
      "id": "text"
    }
  ],
  "pagination": {
    "total": 1,
    "limit": 1,
    "offset": 1
  }
}
  • GETList attributes for multiple identities
  • PUTAdds or Updates attributes to multiple identities
  • DELETEDelete attributes from multiple identities
  • GETlist identities, grantees and approvers

List attributes for multiple identities

get
Authorizations
Query parameters
emailsstring[] | nullableOptional
limitinteger · int32OptionalDefault: 100
skipinteger · int32OptionalDefault: 0
Responses
200
OK
application/json
get
GET /api/v2/bulk/identities/attributes HTTP/1.1
Host: api.apono.io
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
200

OK

{
  "data": [
    {
      "email": "text",
      "attributes": {
        "ANY_ADDITIONAL_PROPERTY": "text"
      }
    }
  ],
  "pagination": {
    "total": 1,
    "limit": 1,
    "offset": 1
  }
}

Adds or Updates attributes to multiple identities

put
Authorizations
Body
emailstringRequired
Responses
200
OK
application/json
put
PUT /api/v2/bulk/identities/attributes HTTP/1.1
Host: api.apono.io
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 66

[
  {
    "email": "text",
    "attributes": {
      "ANY_ADDITIONAL_PROPERTY": "text"
    }
  }
]
200

OK

{
  "summary": {
    "total": 1,
    "succeeded": 1,
    "failed": 1
  },
  "results": [
    {
      "email": "text",
      "success": true,
      "errors": [
        {
          "error_code": "text",
          "error_details": "text"
        }
      ]
    }
  ]
}

Delete attributes from multiple identities

delete
Authorizations
Body
emailstringRequired
attribute_typesstring[]Required
Responses
200
OK
application/json
delete
DELETE /api/v2/bulk/identities/attributes HTTP/1.1
Host: api.apono.io
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 45

[
  {
    "email": "text",
    "attribute_types": [
      "text"
    ]
  }
]
200

OK

{
  "summary": {
    "total": 1,
    "succeeded": 1,
    "failed": 1
  },
  "results": [
    {
      "email": "text",
      "success": true,
      "errors": [
        {
          "error_code": "text",
          "error_details": "text"
        }
      ]
    }
  ]
}