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

Gravitee user API

The user API from Gravitee — 38 operation(s) for user.

Gravitee user API is one of 51 APIs that Gravitee publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

This API exposes 3 JSON Schema definitions.

Tagged areas include User. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, a getting-started guide, a changelog, a GitHub repository, rate-limit docs, and 3 JSON Schemas.

This API exposes 45 operations across 32 paths, and defines 44 schemas. It is described by OpenAPI 3.2.0, at version 4.12.0-alpha.3.

Requests are made against a single base URL, /management.

45 operations 32 paths 44 schemas 10 DELETE17 GET2 PATCH12 POST4 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
4.12.0-alpha.3
Base URL
https://documentation.gravitee.io/apim
Authentication
HTTP Bearer
Resource Areas
1

Authentication & Security 1

Gravitee user API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (gravitee-auth). By default, every request must be authenticated.

Paths & Operations 45

Across 32 paths, the API surfaces 45 operations — 10 DELETE, 17 GET, 2 PATCH, 12 POST, 4 PUT. Each is listed below with its method, path, parameters, and response codes.

user 45
GET
/organizations/{organizationId}/environments/{environmentId}/domains/{domain}/users
List users for a security domain
listUsers 7 params → 200500
POST
/organizations/{organizationId}/environments/{environmentId}/domains/{domain}/users
Create a user on the specified security domain
createUser 3 params body → 201500
POST
/organizations/{organizationId}/environments/{environmentId}/domains/{domain}/users/bulk
Create/update/delete multiple users on the specified security domain
bulkUserOperation 3 params body → 200201500
GET
/organizations/{organizationId}/environments/{environmentId}/domains/{domain}/users/{user}
Get a user
findUser 4 params → 200500
PUT
/organizations/{organizationId}/environments/{environmentId}/domains/{domain}/users/{user}
Update a user
updateUser 4 params body → 201500
DELETE
/organizations/{organizationId}/environments/{environmentId}/domains/{domain}/users/{user}
Delete a user
deleteUser 4 params → 204500
GET
/organizations/{organizationId}/environments/{environmentId}/domains/{domain}/users/{user}/audits
Get a user audit logs
listUserAuditLogs 10 params → 200500
GET
/organizations/{organizationId}/environments/{environmentId}/domains/{domain}/users/{user}/audits/{audit}
Get a user audit log
getUserAuditLog 5 params → 200500
GET
/organizations/{organizationId}/environments/{environmentId}/domains/{domain}/users/{user}/cert-credentials
Get user certificate credentials
listUserCertificateCredentials 4 params → 200404500
POST
/organizations/{organizationId}/environments/{environmentId}/domains/{domain}/users/{user}/cert-credentials
Enroll a certificate credential for a user
enrollUserCertificateCredential 4 params body → 201400404409500
GET
/organizations/{organizationId}/environments/{environmentId}/domains/{domain}/users/{user}/cert-credentials/{credential}
Get a user certificate credential
getUserCertificateCredential 5 params → 200404500
DELETE
/organizations/{organizationId}/environments/{environmentId}/domains/{domain}/users/{user}/cert-credentials/{credential}
Revoke a user certificate credential
revokeUserCertificateCredential 5 params → 204404500
GET
/organizations/{organizationId}/environments/{environmentId}/domains/{domain}/users/{user}/consents
Get a user consents
listUserConsents 5 params → 200500
DELETE
/organizations/{organizationId}/environments/{environmentId}/domains/{domain}/users/{user}/consents
Revoke user consents
revokeUserConsents 5 params → 204500
GET
/organizations/{organizationId}/environments/{environmentId}/domains/{domain}/users/{user}/consents/{consent}
Get a user consent
getUserConsent 5 params → 200500
DELETE
/organizations/{organizationId}/environments/{environmentId}/domains/{domain}/users/{user}/consents/{consent}
Revoke a user consent
revokeUserConsent 5 params → 204500
GET
/organizations/{organizationId}/environments/{environmentId}/domains/{domain}/users/{user}/credentials
Get a user credentials
listUserCredentials 4 params → 200500
GET
/organizations/{organizationId}/environments/{environmentId}/domains/{domain}/users/{user}/credentials/{credential}
Get a user credential
getUserCredential 5 params → 200500
DELETE
/organizations/{organizationId}/environments/{environmentId}/domains/{domain}/users/{user}/credentials/{credential}
Revoke a user credential
revokeUserCredential 5 params → 204500
GET
/organizations/{organizationId}/environments/{environmentId}/domains/{domain}/users/{user}/factors
Get a user enrolled factors
listUserEnrolledFactors 4 params → 200500
DELETE
/organizations/{organizationId}/environments/{environmentId}/domains/{domain}/users/{user}/factors/{factor}
Revoke user factor
deleteUserFactor 5 params → 204500
GET
/organizations/{organizationId}/environments/{environmentId}/domains/{domain}/users/{user}/identities
Get a user linked identities
listUserIdentities 4 params → 200500
DELETE
/organizations/{organizationId}/environments/{environmentId}/domains/{domain}/users/{user}/identities/{identity}
Unlink user identity
unlinkUserIdentity 5 params → 204500
POST
/organizations/{organizationId}/environments/{environmentId}/domains/{domain}/users/{user}/lock
Lock a user
lockUser 4 params → 204500
POST
/organizations/{organizationId}/environments/{environmentId}/domains/{domain}/users/{user}/resetPassword
Reset password
resetPassword 4 params body → 200500
GET
/organizations/{organizationId}/environments/{environmentId}/domains/{domain}/users/{user}/roles
Get a user roles
listUserRoles 5 params → 200500
POST
/organizations/{organizationId}/environments/{environmentId}/domains/{domain}/users/{user}/roles
Assign roles to a user
assignRolesToUser 4 params body → 200500
DELETE
/organizations/{organizationId}/environments/{environmentId}/domains/{domain}/users/{user}/roles/{role}
Revoke role to a user
revokeUserRole 5 params → 200500
POST
/organizations/{organizationId}/environments/{environmentId}/domains/{domain}/users/{user}/sendRegistrationConfirmation
Send registration confirmation email
sendRegistrationConfirmation 4 params → 200500
PUT
/organizations/{organizationId}/environments/{environmentId}/domains/{domain}/users/{user}/status
Update a user status
updateUserStatus 4 params body → 201500
POST
/organizations/{organizationId}/environments/{environmentId}/domains/{domain}/users/{user}/unlock
Unlock a user
unlockUser 4 params → 204500
PATCH
/organizations/{organizationId}/environments/{environmentId}/domains/{domain}/users/{user}/username
Update a user username
updateUsername 4 params body → 201500
GET
/organizations/{organizationId}/users
List users of the organization
listOrganisationUsers 5 params → 200500
POST
/organizations/{organizationId}/users
Create a platform user or Service Account
createOrganisationUser 1 param body → 201500
POST
/organizations/{organizationId}/users/bulk
Create/update/delete platform users or Service Accounts
bulkOrganisationUserOperation 1 param body → 200201500
GET
/organizations/{organizationId}/users/{user}
Get a user
getOrganizationUser 2 params → 200500
PUT
/organizations/{organizationId}/users/{user}
Update a user
updateOrganizationUser 2 params body → 201500
DELETE
/organizations/{organizationId}/users/{user}
Delete a user
deleteOrganizationUser 2 params → 204500
POST
/organizations/{organizationId}/users/{user}/resetPassword
Reset password
resetOrganizationUserPassword 2 params body → 200500
PUT
/organizations/{organizationId}/users/{user}/status
Update a user status
updateOrganizationUserStatus 2 params body → 201500
GET
/organizations/{organizationId}/users/{user}/tokens
Get tokens of a user
getOrganizationUserTokens 2 params → 200500
POST
/organizations/{organizationId}/users/{user}/tokens
Generate an account access token for a user
createAccountAccessToken 2 params body → 201500
DELETE
/organizations/{organizationId}/users/{user}/tokens/{tokenId}
Revoke an account access token
revokeAccountAccessToken 3 params → 200
PATCH
/organizations/{organizationId}/users/{user}/username
Update a user username
updateOrganisationUsername 2 params body → 201500
GET
/user
Get the current user
getCurrentUser → 200500

Schemas 44

The contract defines 44 schemas that model the data the API accepts and returns. The most detailed are UserEntity (73 properties), User (71 properties), NewOrganizationUser (25 properties), NewUser (24 properties). Each schema is shown below with its type and property counts.

BulkOperationResultObject
object
5 properties
UserPage
object
3 properties
AuditEntity
object
7 properties
ScopeApprovalEntity
object
12 properties
NewAccountAccessToken
object
1 property 1 required
OrganizationUserBulkRequest
object
3 properties 2 required
BulkCreateUser
object
3 properties 2 required
Audit
object
11 properties
ApplicationEntity
object
3 properties
Credential
object
18 properties
UserId
object
3 properties
EnrolledFactorSecurity
object
3 properties
BulkUpdateUser
object
3 properties 2 required
CertificateCredential
object
17 properties
AuditAccessPoint
object
5 properties
User
object
71 properties
BulkCreateOrganizationUser
object
3 properties 2 required
Page
object
3 properties
UsernameEntity
object
1 property 1 required
EnrolledFactorChannel
object
3 properties
BulkDeleteUser
object
3 properties 2 required
BulkResponse
object
2 properties
StatusEntity
object
1 property
UserIdentityEntity
object
6 properties
EnrolledFactor
object
8 properties
AuditOutcome
object
2 properties
UpdateUserWithId
object
21 properties
Address
object
8 properties
PasswordValue
object
1 property 1 required
UpdateUser
object
20 properties
NewCertificateCredential
object
1 property 1 required
Reference
object
2 properties
UserIdentity
object
5 properties
NewOrganizationUser
object
25 properties 1 required
Role
object
13 properties
Attribute
object
3 properties
BaseJsonNode
object
EnrolledFactorEntity
object
5 properties
UserEntity
object
73 properties
ScopeEntity
object
4 properties
Certificate
object
1 property
DomainUserBulkRequest
object
3 properties 2 required
NewUser
object
24 properties 1 required
AccountAccessToken
object
10 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

gravitee-user-api-openapi.yml Raw ↑

Other APIs Gravitee publishes across the network.

Gravitee Cockpit
Gravitee Alert Engine
Gravitee AI Agent Management
Gravitee Kafka Gateway
Gravitee Kubernetes Operator
Gravitee alerts API
Gravitee Analytics API
Gravitee API Products API
Gravitee APIs API
Gravitee application API
Gravitee Applications API
Gravitee audit API
Where this information came from

This is an independent, third-party profile of Gravitee user 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.