ACaccessowl
access_states

Import an application's access

Changed on

Imports the complete access list for one application. Users, resources and permissions are matched by email and title. Any access not present in the body is removed. An email matching no known user creates one. If any row cannot be resolved, nothing is written and every rejected row is listed in the response. Importing into an application with an active access-syncing integration is permitted; the next scheduled sync will overwrite what the import wrote. Because this call replaces all of an application's access, send a unique Idempotency-Key header so an accidentally repeated request is rejected rather than re-applied.

put/api/v1/applications/{application_id}/access_states

Request

  • Base URL
    https://app.accessowl.io
  • URL
    https://app.accessowl.io/api/v1/applications/{application_id}/access_states
  • Auth
    HTTP bearer

Path parameters

application_idstring uuid required

Application ID

Headers

Idempotency-Keystring

Optional key (1–255 chars) for safely retrying a request. Reusing the same key for the same request returns 409 Conflict and is not processed again — this confirms the request was already received. Keys are retained for 14 days.

Request body

Example request

{
  "access": [
    {
      "permissions": [
        "Admin"
      ],
      "resource": "Billing",
      "user_email": "ana@example.com"
    }
  ]
}

Response

Import result

Example response

{
  "data": {
    "created": 12,
    "deleted": 5,
    "unchanged": 40,
    "updated": 3
  }
}

Changes

  • 5a1f071e40d8Revision changes
    • breaking

      response property errors/additionalProperties/items/ list-of-types was widened by adding types object to media type application/json of response 422

    • breaking

      removed the required property from the response with the status

    • warning

      removed the optional property from the response with the status

    • warning

      removed the optional property from the response with the status

    • warning

      removed the optional property from the response with the status

    • warning

      added the new forbidden enum value to the response property for the response status

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status

    • info

      added the optional property to the response with the status

  • 56ece6c3256dRevision changes
    • breaking

      the // request property's minItems was increased to 1

    • info

      the request property // became nullable