Permit.io Users Elements Data API
The Users Elements Data API from Permit.io — 6 operation(s) for users elements data.
Work with this as data
Every API here is available over the APIs.io API and to AI agents over MCP.
MCP server
One button, every client — Claude, Cursor, VS Code and the rest.
https://apis.io/mcp
Tools for apis
7 MCP tools reach this
find_apisBrowse and filter every API in the catalog.get_api_artifactsOne API's artifacts, grouped by type.get_openapiThe primary OpenAPI for this API.find_similar_apisAPIs that look like this one.apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.resolveTurn a domain, URL or GitHub org into the provider it belongs to.find_cohortsEvery scored population of providers in the catalog.
Call it yourself
curl for this page
This API
curl "https://apis.io/api/v1/apis/permit-io-users-elements-data-api"
All apis
curl "https://apis.io/api/v1/apis?limit=25"Discovery needs no key. Ratings and market analysis are Pro.
Get an API key
Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.
A second provider on the same verified email joins the account you already have.
OpenAPI Specification
openapi: 3.2.0
info:
title: Permit.io Access Requests (EAP) Access Requests (EAP) Users Elements Data API
description: '
Authorization as a service
'
version: 2.0.0
servers:
- url: https://api.permit.io
description: Base URL declared by the provider in apis.yml (roadmap#122).
tags:
- name: Users Elements Data
paths:
/v2/elements/{proj_id}/{env_id}/config/{elements_config_id}/data/users:
get:
tags:
- Users Elements Data
summary: List users
description: Lists all the users defined within an environment.
operationId: elements_list_users
parameters:
- description: 'Either the unique id of the elements_config, or the URL-friendly key of the elements_config (i.e: the "slug").'
required: true
schema:
type: string
title: Elements Config Id
description: 'Either the unique id of the elements_config, or the URL-friendly key of the elements_config (i.e: the "slug").'
example: my_elements_config
name: elements_config_id
in: path
- description: 'Either the unique id of the project, or the URL-friendly key of the project (i.e: the "slug").'
required: true
schema:
type: string
title: Proj Id
description: 'Either the unique id of the project, or the URL-friendly key of the project (i.e: the "slug").'
example: my_project
name: proj_id
in: path
- description: 'Either the unique id of the environment, or the URL-friendly key of the environment (i.e: the "slug").'
required: true
schema:
type: string
title: Env Id
description: 'Either the unique id of the environment, or the URL-friendly key of the environment (i.e: the "slug").'
example: my_environment
name: env_id
in: path
- description: Text search for the email field
required: false
schema:
type: string
title: Search
description: Text search for the email field
name: search
in: query
- description: Page number of the results to fetch, starting at 1.
required: false
schema:
type: integer
minimum: 1.0
title: Page
description: Page number of the results to fetch, starting at 1.
default: 1
name: page
in: query
- description: The number of results per page (max 100).
required: false
schema:
type: integer
maximum: 100.0
minimum: 1.0
title: Per Page
description: The number of results per page (max 100).
default: 30
name: per_page
in: query
- description: For ReBAC Elements, the resource instance ID or key to work on
required: false
schema:
type: string
title: Resource Instance Id
description: For ReBAC Elements, the resource instance ID or key to work on
name: resource_instance_id
in: query
responses:
'200':
description: Successful Response
content:
application/json:
schema:
$ref: '#/components/schemas/PaginatedResult_UserRead_'
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
security:
- HTTPBearer: []
post:
tags:
- Users Elements Data
summary: Create user
description: 'Creates a new user inside the Permit.io system, from that point forward
you may run permission checks on that user.
If the user is already created: will return 200 instead of 201,
and will return the existing user object in the response body.'
operationId: elements_create_user
parameters:
- description: 'Either the unique id of the elements_config, or the URL-friendly key of the elements_config (i.e: the "slug").'
required: true
schema:
type: string
title: Elements Config Id
description: 'Either the unique id of the elements_config, or the URL-friendly key of the elements_config (i.e: the "slug").'
example: my_elements_config
name: elements_config_id
in: path
- description: 'Either the unique id of the project, or the URL-friendly key of the project (i.e: the "slug").'
required: true
schema:
type: string
title: Proj Id
description: 'Either the unique id of the project, or the URL-friendly key of the project (i.e: the "slug").'
example: my_project
name: proj_id
in: path
- description: 'Either the unique id of the environment, or the URL-friendly key of the environment (i.e: the "slug").'
required: true
schema:
type: string
title: Env Id
description: 'Either the unique id of the environment, or the URL-friendly key of the environment (i.e: the "slug").'
example: my_environment
name: env_id
in: path
- description: For ReBAC Elements, the resource instance ID or key to work on
required: false
schema:
type: string
title: Resource Instance Id
description: For ReBAC Elements, the resource instance ID or key to work on
name: resource_instance_id
in: query
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/ElementsUserCreate'
required: true
responses:
'200':
description: Successful Response
content:
application/json:
schema:
anyOf:
- $ref: '#/components/schemas/UserRead'
- $ref: '#/components/schemas/ElementsUserInviteRead'
title: Response Elements Create User V2 Elements Proj Id Env Id Config Elements Config Id Data Users Post
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
security:
- HTTPBearer: []
/v2/elements/{proj_id}/{env_id}/config/{elements_config_id}/data/users/{user_id}:
delete:
tags:
- Users Elements Data
summary: Delete user
operationId: elements_delete_user
parameters:
- description: 'Either the unique id of the project, or the URL-friendly key of the project (i.e: the "slug").'
required: true
schema:
type: string
title: Proj Id
description: 'Either the unique id of the project, or the URL-friendly key of the project (i.e: the "slug").'
example: my_project
name: proj_id
in: path
- description: 'Either the unique id of the environment, or the URL-friendly key of the environment (i.e: the "slug").'
required: true
schema:
type: string
title: Env Id
description: 'Either the unique id of the environment, or the URL-friendly key of the environment (i.e: the "slug").'
example: my_environment
name: env_id
in: path
- description: 'Either the unique id of the elements_config, or the URL-friendly key of the elements_config (i.e: the "slug").'
required: true
schema:
type: string
title: Elements Config Id
description: 'Either the unique id of the elements_config, or the URL-friendly key of the elements_config (i.e: the "slug").'
example: my_elements_config
name: elements_config_id
in: path
- description: 'Either the unique id of the user, or the URL-friendly key of the user (i.e: the "slug").'
required: true
schema:
type: string
title: User Id
description: 'Either the unique id of the user, or the URL-friendly key of the user (i.e: the "slug").'
name: user_id
in: path
- description: For ReBAC Elements, the resource instance ID or key to work on
required: false
schema:
type: string
title: Resource Instance Id
description: For ReBAC Elements, the resource instance ID or key to work on
name: resource_instance_id
in: query
responses:
'204':
description: Successful Response
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
security:
- HTTPBearer: []
/v2/elements/{proj_id}/{env_id}/config/{elements_config_id}/data/user-invites:
get:
tags:
- Users Elements Data
summary: List all Elements User Invites
description: List all Elements User Invites for the current environment and tenant.
operationId: list_elements_user_invites
parameters:
- description: 'Either the unique id of the elements_config, or the URL-friendly key of the elements_config (i.e: the "slug").'
required: true
schema:
type: string
title: Elements Config Id
description: 'Either the unique id of the elements_config, or the URL-friendly key of the elements_config (i.e: the "slug").'
example: my_elements_config
name: elements_config_id
in: path
- description: 'Either the unique id of the project, or the URL-friendly key of the project (i.e: the "slug").'
required: true
schema:
type: string
title: Proj Id
description: 'Either the unique id of the project, or the URL-friendly key of the project (i.e: the "slug").'
example: my_project
name: proj_id
in: path
- description: 'Either the unique id of the environment, or the URL-friendly key of the environment (i.e: the "slug").'
required: true
schema:
type: string
title: Env Id
description: 'Either the unique id of the environment, or the URL-friendly key of the environment (i.e: the "slug").'
example: my_environment
name: env_id
in: path
- description: Text search for the email field
required: false
schema:
type: string
title: Search
description: Text search for the email field
name: search
in: query
- description: Status of the user invite
required: false
schema:
allOf:
- $ref: '#/components/schemas/UserInviteStatus'
description: Status of the user invite
name: status
in: query
- description: Page number of the results to fetch, starting at 1.
required: false
schema:
type: integer
minimum: 1.0
title: Page
description: Page number of the results to fetch, starting at 1.
default: 1
name: page
in: query
- description: The number of results per page (max 100).
required: false
schema:
type: integer
maximum: 100.0
minimum: 1.0
title: Per Page
description: The number of results per page (max 100).
default: 30
name: per_page
in: query
- description: For ReBAC Elements, the resource instance ID or key to work on
required: false
schema:
type: string
title: Resource Instance Id
description: For ReBAC Elements, the resource instance ID or key to work on
name: resource_instance_id
in: query
responses:
'200':
description: Successful Response
content:
application/json:
schema:
$ref: '#/components/schemas/PaginatedResult_ElementsUserInviteRead_'
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
security:
- HTTPBearer: []
/v2/elements/{proj_id}/{env_id}/config/{elements_config_id}/data/roles:
get:
tags:
- Users Elements Data
summary: List roles
description: Lists all the users defined within an environment.
operationId: elements_list_roles
parameters:
- description: 'Either the unique id of the elements_config, or the URL-friendly key of the elements_config (i.e: the "slug").'
required: true
schema:
type: string
title: Elements Config Id
description: 'Either the unique id of the elements_config, or the URL-friendly key of the elements_config (i.e: the "slug").'
example: my_elements_config
name: elements_config_id
in: path
- description: 'Either the unique id of the project, or the URL-friendly key of the project (i.e: the "slug").'
required: true
schema:
type: string
title: Proj Id
description: 'Either the unique id of the project, or the URL-friendly key of the project (i.e: the "slug").'
example: my_project
name: proj_id
in: path
- description: 'Either the unique id of the environment, or the URL-friendly key of the environment (i.e: the "slug").'
required: true
schema:
type: string
title: Env Id
description: 'Either the unique id of the environment, or the URL-friendly key of the environment (i.e: the "slug").'
example: my_environment
name: env_id
in: path
- description: Text search for the email field
required: false
schema:
type: string
title: Search
description: Text search for the email field
name: search
in: query
- description: Page number of the results to fetch, starting at 1.
required: false
schema:
type: integer
minimum: 1.0
title: Page
description: Page number of the results to fetch, starting at 1.
default: 1
name: page
in: query
- description: The number of results per page (max 100).
required: false
schema:
type: integer
maximum: 100.0
minimum: 1.0
title: Per Page
description: The number of results per page (max 100).
default: 30
name: per_page
in: query
- description: For ReBAC Elements, the resource instance ID or key to work on
required: false
schema:
type: string
title: Resource Instance Id
description: For ReBAC Elements, the resource instance ID or key to work on
name: resource_instance_id
in: query
responses:
'200':
description: Successful Response
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ElementsRoleRead'
type: array
title: Response Elements List Roles V2 Elements Proj Id Env Id Config Elements Config Id Data Roles Get
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
security:
- HTTPBearer: []
/v2/elements/{proj_id}/{env_id}/config/{elements_config_id}/data/users/{user_id}/roles:
post:
tags:
- Users Elements Data
summary: Assign role to user
description: 'Assigns a role to the user within the tenant.
The tenant defines the scope of the assignment. In other words, the role is effective only within the tenant.'
operationId: elements_assign_role_to_user
parameters:
- description: 'Either the unique id of the elements_config, or the URL-friendly key of the elements_config (i.e: the "slug").'
required: true
schema:
type: string
title: Elements Config Id
description: 'Either the unique id of the elements_config, or the URL-friendly key of the elements_config (i.e: the "slug").'
example: my_elements_config
name: elements_config_id
in: path
- description: 'Either the unique id of the user, or the URL-friendly key of the user (i.e: the "slug").'
required: true
schema:
type: string
title: User Id
description: 'Either the unique id of the user, or the URL-friendly key of the user (i.e: the "slug").'
name: user_id
in: path
- description: 'Either the unique id of the project, or the URL-friendly key of the project (i.e: the "slug").'
required: true
schema:
type: string
title: Proj Id
description: 'Either the unique id of the project, or the URL-friendly key of the project (i.e: the "slug").'
example: my_project
name: proj_id
in: path
- description: 'Either the unique id of the environment, or the URL-friendly key of the environment (i.e: the "slug").'
required: true
schema:
type: string
title: Env Id
description: 'Either the unique id of the environment, or the URL-friendly key of the environment (i.e: the "slug").'
example: my_environment
name: env_id
in: path
- description: For ReBAC Elements, the resource instance ID or key to work on
required: false
schema:
type: string
title: Resource Instance Id
description: For ReBAC Elements, the resource instance ID or key to work on
name: resource_instance_id
in: query
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/ElementsUserRoleCreate'
required: true
responses:
'200':
description: Successful Response
content:
application/json:
schema:
$ref: '#/components/schemas/RoleAssignmentRead'
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
security:
- HTTPBearer: []
delete:
tags:
- Users Elements Data
summary: Unassign role from user
description: 'Unassigns the role from the user within the tenant.
The tenant defines the scope of the assignment. In other words, the role is effective only within the tenant.
If the role is not actually assigned, will return 404.'
operationId: elements_unassign_role_from_user
parameters:
- description: 'Either the unique id of the elements_config, or the URL-friendly key of the elements_config (i.e: the "slug").'
required: true
schema:
type: string
title: Elements Config Id
description: 'Either the unique id of the elements_config, or the URL-friendly key of the elements_config (i.e: the "slug").'
example: my_elements_config
name: elements_config_id
in: path
- description: 'Either the unique id of the user, or the URL-friendly key of the user (i.e: the "slug").'
required: true
schema:
type: string
title: User Id
description: 'Either the unique id of the user, or the URL-friendly key of the user (i.e: the "slug").'
name: user_id
in: path
- description: 'Either the unique id of the project, or the URL-friendly key of the project (i.e: the "slug").'
required: true
schema:
type: string
title: Proj Id
description: 'Either the unique id of the project, or the URL-friendly key of the project (i.e: the "slug").'
example: my_project
name: proj_id
in: path
- description: 'Either the unique id of the environment, or the URL-friendly key of the environment (i.e: the "slug").'
required: true
schema:
type: string
title: Env Id
description: 'Either the unique id of the environment, or the URL-friendly key of the environment (i.e: the "slug").'
example: my_environment
name: env_id
in: path
- description: For ReBAC Elements, the resource instance ID or key to work on
required: false
schema:
type: string
title: Resource Instance Id
description: For ReBAC Elements, the resource instance ID or key to work on
name: resource_instance_id
in: query
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/ElementsUserRoleRemove'
required: true
responses:
'204':
description: Successful Response
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
security:
- HTTPBearer: []
/v2/elements/{proj_id}/{env_id}/config/{elements_config_id}/data/active:
post:
tags:
- Users Elements Data
summary: Set Config Active
description: Updates the embed_config.
operationId: set_config_active
parameters:
- description: 'Either the unique id of the elements_config, or the URL-friendly key of the elements_config (i.e: the "slug").'
required: true
schema:
type: string
title: Elements Config Id
description: 'Either the unique id of the elements_config, or the URL-friendly key of the elements_config (i.e: the "slug").'
example: my_elements_config
name: elements_config_id
in: path
- description: 'Either the unique id of the project, or the URL-friendly key of the project (i.e: the "slug").'
required: true
schema:
type: string
title: Proj Id
description: 'Either the unique id of the project, or the URL-friendly key of the project (i.e: the "slug").'
example: my_project
name: proj_id
in: path
- description: 'Either the unique id of the environment, or the URL-friendly key of the environment (i.e: the "slug").'
required: true
schema:
type: string
title: Env Id
description: 'Either the unique id of the environment, or the URL-friendly key of the environment (i.e: the "slug").'
example: my_environment
name: env_id
in: path
responses:
'204':
description: Successful Response
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
security:
- HTTPBearer: []
components:
schemas:
ElementsUserRoleCreate:
properties:
role:
type: string
title: Role
description: the role that will be assigned (accepts either the role id or the role key)
additionalProperties: false
type: object
required:
- role
title: ElementsUserRoleCreate
example:
role: admin
UserStatus:
type: string
enum:
- active
- pending
title: UserStatus
description: An enumeration.
ElementsUserRoleRemove:
properties:
role:
type: string
title: Role
description: the role that will be unassigned (accepts either the role id or the role key)
additionalProperties: false
type: object
required:
- role
title: ElementsUserRoleRemove
example:
role: editor
PaginatedResult_UserRead_:
properties:
data:
items:
$ref: '#/components/schemas/UserRead'
type: array
title: Data
description: List of Users
total_count:
type: integer
minimum: 0.0
title: Total Count
page_count:
type: integer
minimum: 0.0
title: Page Count
default: 0
additionalProperties: false
type: object
required:
- data
- total_count
title: PaginatedResult[UserRead]
UserRead:
properties:
key:
type: string
title: Key
description: A unique id by which Permit will identify the user for permission checks.
id:
type: string
format: uuid
title: Id
description: Unique id of the user
organization_id:
type: string
format: uuid
title: Organization Id
description: Unique id of the organization that the user belongs to.
project_id:
type: string
format: uuid
title: Project Id
description: Unique id of the project that the user belongs to.
environment_id:
type: string
format: uuid
title: Environment Id
description: Unique id of the environment that the user belongs to.
associated_tenants:
items:
$ref: '#/components/schemas/UserInTenant'
type: array
title: Associated Tenants
default: []
roles:
items:
$ref: '#/components/schemas/UserRole'
type: array
title: Roles
default: []
deprecated: true
created_at:
type: string
format: date-time
title: Created At
description: Date and time when the user was created (ISO_8601 format).
updated_at:
type: string
format: date-time
title: Updated At
description: Date and time when the user was last updated/modified (ISO_8601 format).
email:
type: string
format: email
title: Email
description: The email of the user. If synced, will be unique inside the environment.
first_name:
type: string
title: First Name
description: First name of the user.
last_name:
type: string
title: Last Name
description: Last name of the user.
attributes:
type: object
title: Attributes
description: Arbitrary user attributes that will be used to enforce attribute-based access control policies.
default: {}
additionalProperties: false
type: object
required:
- key
- id
- organization_id
- project_id
- environment_id
- created_at
- updated_at
title: UserRead
example:
id: 497f6eca-6276-4993-bfeb-53cbbbba6f08
organization_id: 7c60d51f-b44e-4682-87d6-449835ea4de6
project_id: 405d8375-3514-403b-8c43-83ae74cfe0e9
environment_id: 40ef0e48-a11f-4963-a229-e396c9f7e7c4
key: user|892179821739812389327
email: jane@coolcompany.com
created_at: '2019-08-24T14:15:22Z'
updated_at: '2019-08-24T14:15:22Z'
first_name: Jane
last_name: Doe
attributes:
department: marketing
age: 30
subscription:
tier: pro
expired: false
associated_tenants:
- tenant: stripe-inc
roles:
- admin
status: active
- tenant: othercompany.com
roles:
- viewer
status: pending
roles:
- role: admin
tenant: stripe-inc
- role: viewer
tenant: othercompany.com
HTTPValidationError:
properties:
detail:
items:
$ref: '#/components/schemas/ValidationError'
type: array
title: Detail
type: object
title: HTTPValidationError
UserRole:
properties:
role:
type: string
title: Role
description: the role that is assigned
tenant:
type: string
title: Tenant
description: the tenant the role is associated with
additionalProperties: false
type: object
required:
- role
- tenant
title: UserRole
ElementsRoleRead:
properties:
id:
type: string
format: uuid
title: Id
description: Unique id of the role
key:
type: string
title: Key
description: 'A URL-friendly name of the role (i.e: slug). You will be able to query later using this key instead of the id (UUID) of the role.'
name:
type: string
title: Name
description: The name of the role
permission_level:
$ref: '#/components/schemas/ElementsPermissionLevel'
additionalProperties: false
type: object
required:
- id
- key
- name
- permission_level
title: ElementsRoleRead
example:
id: 497f6eca-6276-4993-bfeb-53cbbbba6f08
key: editor
name: Editor
permission_level: LEVEL_2
RoleAssignmentRead:
properties:
id:
type: string
format: uuid
title: Id
description: Unique id of the role assignment
user:
type: string
title: User
description: the user the role is assigned to
role:
type: string
title: Role
description: the role that is assigned
tenant:
type: string
title: Tenant
description: the tenant the role is associated with
resource_instance:
type: string
title: Resource Instance
description: the resource instance the role is associated with
resource_instance_id:
type: string
format: uuid
title: Resource Instance Id
description: Unique id of the resource instance
user_id:
type: string
format: uuid
title: User Id
description: Unique id of the user
role_id:
type: string
format: uuid
title: Role Id
description: Unique id of the role
tenant_id:
type: string
format: uuid
title: Tenant Id
description: Unique id of the tenant
organization_id:
type: string
format: uuid
title: Organization Id
description: Unique id of the organization that the role assignment belongs to.
project_id:
type: string
format: uuid
title: Project Id
description: Unique id of the project that the role assignment belongs to.
environment_id:
type: string
format: uuid
title: Environment Id
description: Unique id of the environment that the role assignment belongs to.
created_at:
type: string
format: date-time
title: Created At
description: Date and time when the role assignment was created (ISO_8601 format).
additionalProperties: false
type: object
required:
- id
- user
- role
- user_id
- role_id
- tenant_id
- organization_id
- project_id
- environment_id
- created_at
title: RoleAssignmentRead
example:
id: 497f6eca-6276-4993-bfeb-53cbbbba6f08
user: jane@coolcompany.com
role: admin
tenant: stripe-inc
user_id: 7c60d51f-b44e-4682-87d6-449835ea4d11
role_id: 405d8375-3514-403b-8c43-83ae74cfe022
tenant_id: 40ef0e48-a11f-4963-a229-e396c9f7e733
organization_id: 7c60d51f-b44e-4682-87d6-449835ea4de6
project_id: 405d8375-3514-403b-8c43-83ae74cfe0e9
environment_id: 40ef0e48-a11f-4963-a229-e396c9f7e7c4
created_at: '2019-08-24T14:15:22Z'
ElementsUserInviteRead:
properties:
id:
type: string
format: uuid
title: Id
description: Unique id of the elements_user_invite
organization_id:
type: string
format: uuid
title: Organization Id
description: Unique id of the organization that the elements_user_invite belongs to.
project
# --- truncated at 32 KB (39 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/permit-io/refs/heads/main/openapi/permit-io-users-elements-data-api-openapi.yml