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 Groups API

A group is a logical collection of identities. Groups are commonly used as a predicate in a policy rule.

Beyond Identity Groups 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 Group. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and 2 JSON Schemas.

This API exposes 9 operations across 6 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/.

9 operations 6 paths 9 schemas 1 DELETE4 GET1 PATCH3 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 Groups 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 9

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

Groups 9

A group is a logical collection of identities. Groups are commonly used as a predicate in a policy rule.

POST
/v1/tenants/{tenant_id}/realms/{realm_id}/groups
Create a New Group
CreateGroup 2 params body → 200400401403404500
GET
/v1/tenants/{tenant_id}/realms/{realm_id}/groups
List Groups for a Realm
ListGroups 5 params → 200400401403404500
GET
/v1/tenants/{tenant_id}/realms/{realm_id}/groups/{group_id}
Retrieve an Existing Group
GetGroup 3 params → 200401403404500
PATCH
/v1/tenants/{tenant_id}/realms/{realm_id}/groups/{group_id}
Patch a Group
UpdateGroup 3 params body → 200400401403404500
DELETE
/v1/tenants/{tenant_id}/realms/{realm_id}/groups/{group_id}
Delete a Group
DeleteGroup 3 params → 200401403404409500
POST
/v1/tenants/{tenant_id}/realms/{realm_id}/groups/{group_id}:addMembers
Add Members to a Group
AddGroupMembers 3 params body → 200400401403404500
POST
/v1/tenants/{tenant_id}/realms/{realm_id}/groups/{group_id}:deleteMembers
Delete Members from a Group
DeleteGroupMembers 3 params body → 200400401403404500
GET
/v1/tenants/{tenant_id}/realms/{realm_id}/groups/{group_id}:listMembers
List Members for a Group
ListGroupMembers 6 params → 200400401403404500
GET
/v1/tenants/{tenant_id}/realms/{realm_id}/groups/{group_id}:listRoles
List Role Memberships for a Group
ListGroupRoles 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.

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
ListGroupMembersResponse
object
Response for ListGroupMembers.
3 properties 2 required
ErrorDetail
object
Additional details for errors designed to support client applications.
1 property 1 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
ListGroupRolesResponse
object
Response for ListGroupRoles.
3 properties 2 required
Traits_v0
object
Set of traits associated with an identity.
34 properties 1 required
Error
object
3 properties 2 required
ListGroupsResponse
object
Response for ListGroups.
3 properties 2 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

beyond-identity-groups-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 Identities 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 Groups 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.