PEpermify
Permission

lookup entity

Changed on
post/v1/tenants/{tenant_id}/permissions/lookup-entity

Request

  • The document declares no server URL.
  • Auth
    none declared

Path parameters

tenant_idstring required

Identifier of the tenant, if you are not using multi-tenancy (have only one tenant) use pre-inserted tenant <code>t1</code> for this field. Required, and must match the pattern \“[a-zA-Z0-9-,]+\“, max 64 bytes.

Request body

entity_typestring

Type of the entity to lookup, required, must start with a letter and can include alphanumeric and underscore, max 64 bytes.

permissionstring

Name of the permission to check, required, must start with a letter and can include alphanumeric and underscore, max 64 bytes.

scopeobject

Scope: A map that associates entity types with lists of identifiers. Each entry helps filter requests by specifying which entities are relevant to the operation.

page_sizeinteger

page_size is the number of entities to be returned in the response. The value should be between 1 and 100.

continuous_tokenstring

continuous_token is an optional parameter used for pagination. It should be the value received in the previous response.

Response

A successful response.

entity_idsstring[]

List of identifiers for entities that match the lookup.

continuous_tokenstring

continuous_token is a string that can be used to paginate and retrieve the next set of results.

Changes

  • f37e45046dd2Revision changes
    • breaking

      the //// request property type changed from object to no type

    • breaking

      the // response's property type changed from object to no type for status

    • info

      added the new optional request property

  • b7278a55155eRevision changes
    • info

      added the new optional request property

    • info

      added the new optional request property

    • info

      added the optional property to the response with the status