How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Beyond Identity Identities API

An identity is a unique identifier that may be used by an end-user to gain access governed by Beyond Identity.

Beyond Identity Identities API is one of 17 APIs that Beyond Identity publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

This API exposes 2 JSON Schema definitions.

Tagged areas include Identities. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and 2 JSON Schemas.

This API exposes 8 operations across 5 paths, and defines 9 schemas. It is described by OpenAPI 3.0.1, at version 1.7.0.

Requests are made against 3 base URLs: https://api-us.beyondidentity.com, https://api-eu.beyondidentity.com, https://api.us1.beyondidentity-gov.com/.

8 operations 5 paths 9 schemas 1 DELETE4 GET1 PATCH2 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.1
API Version
1.7.0
Base URL
https://api-us.beyondidentity.com
Authentication
HTTP Bearer
Resource Areas
1

Authentication & Security 1

Beyond Identity Identities API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (JWT) (BearerAuth). By default, every request must be authenticated.

  • BearerAuth — See the [Authentication](section/Authentication) section for details.

Paths & Operations 8

Across 5 paths, the API surfaces 8 operations — 1 DELETE, 4 GET, 1 PATCH, 2 POST. Each is listed below with its method, path, parameters, and response codes.

Identities 8

An identity is a unique identifier that may be used by an end-user to gain access governed by Beyond Identity.

POST
/v1/tenants/{tenant_id}/realms/{realm_id}/identities
Create a New Identity
CreateIdentity 2 params body → 200400401403404409500
GET
/v1/tenants/{tenant_id}/realms/{realm_id}/identities
List Identities for a Realm
ListIdentities 6 params → 200400401403404500
POST
/v1/tenants/{tenant_id}/realms/{realm_id}/identities:batchDelete
Batch delete identities.
BatchDeleteIdentities 2 params body → 200401403404500
GET
/v1/tenants/{tenant_id}/realms/{realm_id}/identities/{identity_id}
Retrieve an Existing Identity
GetIdentity 3 params → 200401403404500
PATCH
/v1/tenants/{tenant_id}/realms/{realm_id}/identities/{identity_id}
Patch an Identity
UpdateIdentity 3 params body → 200400401403404409500
DELETE
/v1/tenants/{tenant_id}/realms/{realm_id}/identities/{identity_id}
Delete an Identity
DeleteIdentity 3 params → 200401403404500
GET
/v1/tenants/{tenant_id}/realms/{realm_id}/identities/{identity_id}:listGroups
List Group Memberships for an Identity
ListIdentityGroups 6 params → 200400401403404500
GET
/v1/tenants/{tenant_id}/realms/{realm_id}/identities/{identity_id}:listRoles
List Role Memberships for an Identity
ListIdentityRoles 7 params → 200400401403404409500

Schemas 9

The contract defines 9 schemas that model the data the API accepts and returns. The most detailed are Traits_v0 (34 properties), Identity (9 properties), Role (8 properties), Group (7 properties). Each schema is shown below with its type and property counts.

ListIdentityRolesResponse
object
Response for ListIdentityRoles.
3 properties 2 required
Role
object
A role is a logical collection of scopes. Roles are commonly used to limit access control. The scopes belonging to a role are limited to its associated resourc…
8 properties
Group
object
A group is a logical collection of identities. Groups are commonly used as a predicate in a policy rule.
7 properties
ErrorDetail
object
Additional details for errors designed to support client applications.
1 property 1 required
ListIdentityGroupsResponse
object
Response for ListIdentityGroups.
3 properties 2 required
Identity
object
An identity is a unique identifier that may be used by an end-user to gain access governed by Beyond Identity.
9 properties
Traits_v0
object
Set of traits associated with an identity.
34 properties 1 required
ListIdentitiesResponse
object
Response for ListIdentities.
3 properties 2 required
Error
object
3 properties 2 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

beyond-identity-identities-api-openapi.yml Raw ↑

Other APIs Beyond Identity publishes across the network.

Beyond Identity Next Generation API
Beyond Identity Applications API
Beyond Identity Authenticator Configurations API
Beyond Identity Credential Binding Jobs API
Beyond Identity Credentials API
Beyond Identity Groups API
Beyond Identity Identity Provider API
Beyond Identity Launch Mechanisms API
Beyond Identity Realms API
Beyond Identity Resource Servers API
Beyond Identity Roles API
Beyond Identity SCIM API
Where this information came from

This is an independent, third-party profile of Beyond Identity Identities API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.