Identities

PreviousAccess Flows NextConnectors

Last updated 3 months ago

Was this helpful?

List attributes for multiple identities

get

/api/v2/bulk/identities/attributes

Authorizations

Query parameters

emailsstring[] | nullable

limitinteger · int32 · default: 100

skipinteger · int32

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url 'https://api.apono.io/api/v2/bulk/identities/attributes' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN'

200

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

Adds or Updates attributes to multiple identities

put

/api/v2/bulk/identities/attributes

Authorizations

Body

emailstringrequired

attributesobjectrequired

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request PUT \
  --url 'https://api.apono.io/api/v2/bulk/identities/attributes' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN' \
  --header 'Content-Type: application/json' \
  --data '[{"email":"text","attributes":{"ANY_ADDITIONAL_PROPERTY":"text"}}]'

200

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

/api/v2/bulk/identities/attributes

Authorizations

Body

emailstringrequired

attribute_typesstring[]required

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request DELETE \
  --url 'https://api.apono.io/api/v2/bulk/identities/attributes' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN' \
  --header 'Content-Type: application/json' \
  --data '[{"email":"text","attribute_types":[null]}]'

200

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

list identities, grantees and approvers

get

/api/v2/identities

Authorizations

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url 'https://api.apono.io/api/v2/identities' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN'

200

{
  "pagination": {
    "total": 1,
    "limit": 1,
    "offset": 1
  },
  "data": [
    {
      "type": "text",
      "name": "text",
      "id": "text"
    }
  ]
}