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 protected-resource API

The protected-resource API from Gravitee — 8 operation(s) for protected-resource.

Gravitee protected-resource 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 protected-resource. 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 14 operations across 8 paths, and defines 43 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.

14 operations 8 paths 43 schemas 3 DELETE5 GET1 PATCH4 POST1 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 protected-resource API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (gravitee-auth). By default, every request must be authenticated.

Paths & Operations 14

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

protected-resource 14
GET
/organizations/{organizationId}/environments/{environmentId}/domains/{domain}/protected-resources
List registered protected resources for a security domain
listProtectedResources 8 params → 200500
POST
/organizations/{organizationId}/environments/{environmentId}/domains/{domain}/protected-resources
Create a Protected Resource definition
createProtectedResource 3 params body → 201500
GET
/organizations/{organizationId}/environments/{environmentId}/domains/{domain}/protected-resources/{protected-resource}
Get a Protected Resource
findProtectedResource 5 params → 200500
PUT
/organizations/{organizationId}/environments/{environmentId}/domains/{domain}/protected-resources/{protected-resource}
Update a Protected Resource
updateProtectedResource 4 params body → 200500
DELETE
/organizations/{organizationId}/environments/{environmentId}/domains/{domain}/protected-resources/{protected-resource}
Delete a Protected Resource
deleteProtectedResource 5 params → 204404403500
PATCH
/organizations/{organizationId}/environments/{environmentId}/domains/{domain}/protected-resources/{protected-resource}
Patch a Protected Resource
patchProtectedResource 4 params body → 200500
GET
/organizations/{organizationId}/environments/{environmentId}/domains/{domain}/protected-resources/{protected-resource}/members
List members for an protected resource
getMembers_1 4 params → 200500
POST
/organizations/{organizationId}/environments/{environmentId}/domains/{domain}/protected-resources/{protected-resource}/members
Add or update an protected resource member
addOrUpdateMember_2 4 params body → 201400404500
GET
/organizations/{organizationId}/environments/{environmentId}/domains/{domain}/protected-resources/{protected-resource}/members/permissions
List protected resource member's permissions
getProtectedResourceMemberPermissions 4 params → 200500
DELETE
/organizations/{organizationId}/environments/{environmentId}/domains/{domain}/protected-resources/{protected-resource}/members/{member}
Remove a membership
removeProtectedResourceMember 5 params → 204500
GET
/organizations/{organizationId}/environments/{environmentId}/domains/{domain}/protected-resources/{protected-resource}/secrets
List secrets of a protected resource
getSecrets 4 params → 200500
POST
/organizations/{organizationId}/environments/{environmentId}/domains/{domain}/protected-resources/{protected-resource}/secrets
Create a secret for a protected resource
create 4 params body → 201500
DELETE
/organizations/{organizationId}/environments/{environmentId}/domains/{domain}/protected-resources/{protected-resource}/secrets/{secretId}
Remove a secret for a protected resource
delete 5 params → 204404500
POST
/organizations/{organizationId}/environments/{environmentId}/domains/{domain}/protected-resources/{protected-resource}/secrets/{secretId}/_renew
Renew a secret for a protected resource
renew 5 params → 200500

Schemas 43

The contract defines 43 schemas that model the data the API accepts and returns. The most detailed are ApplicationOAuthSettings (71 properties), AccountSettings (27 properties), ApplicationSAMLSettings (17 properties), LoginSettings (16 properties). Each schema is shown below with its type and property counts.

ApplicationSecretSettings
object
2 properties
SecretExpirationSettings
object
2 properties
NewProtectedResourceFeature
object
3 properties 2 required
RememberDeviceSettings
object
5 properties
PasswordSettings
object
12 properties
FormField
object
3 properties
UpdateProtectedResource
object
5 properties 2 required
ProtectedResourceFeature
object
5 properties
LoginSettings
object
16 properties
ApplicationSAMLSettings
object
17 properties
StepUpAuthenticationSettings
object
2 properties
EnrollSettings
object
7 properties
FactorSettings
object
2 properties
EnrollmentSettings
object
2 properties
UpdateProtectedResourceFeature
object
3 properties 2 required
AssessmentSettings
object
2 properties
ProtectedResourcePrimaryData
object
11 properties
CookieSettings
object
2 properties
ApplicationSettings
object
10 properties
ApplicationScopeSettings
object
3 properties
NewMembership
object
3 properties 3 required
PatchProtectedResource
object
7 properties
JWK
object
9 properties
JWKSet
object
1 property
ApplicationOAuthSettings
object
71 properties
ProtectedResourcePage
object
3 properties
Membership
object
10 properties
ProtectedResourceSecret
object
4 properties
ApplicationFactorSettings
object
2 properties
UserInfoClaim
object
2 properties
TokenExchangeOAuthSettings
object
2 properties
MFASettings
object
9 properties
MembershipListItem
object
2 properties
NewClientSecret
object
1 property 1 required
AccountSettings
object
27 properties
SAMLAssertionAttribute
object
2 properties 2 required
ClientSecret
object
6 properties
NewProtectedResource
object
8 properties 3 required
RiskAssessmentSettings
object
4 properties
ChallengeSettings
object
3 properties
SessionSettings
object
1 property
ApplicationAdvancedSettings
object
2 properties
TokenClaim
object
3 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

gravitee-protected-resource-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 protected-resource 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.