Gravitee

Gravitee Organizations API

The Organizations API from Gravitee — 5 operation(s) for organizations.

GitHub OpenAPI

Documentation

📖
Documentation
https://documentation.gravitee.io/apim
📖
GettingStarted
https://documentation.gravitee.io/apim/getting-started
📖
RateLimits
https://raw.githubusercontent.com/api-evangelist/gravitee/refs/heads/main/rate-limits/gravitee-rate-limits.yml
📖
Documentation
https://documentation.gravitee.io/am

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/gravitee/refs/heads/main/openapi/gravitee-organizations-api-openapi.yml

SDKs

📦
GitHubRepository
https://github.com/gravitee-io/gravitee-api-management
📦
GitHubRepository
https://github.com/gravitee-io/gravitee-access-management

Schemas & Data

📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/gravitee/refs/heads/main/json-schema/gravitee-api-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/gravitee/refs/heads/main/json-schema/gravitee-plan-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/gravitee/refs/heads/main/json-schema/gravitee-domain-schema.json

Other Resources

🔗
ChangeLog
https://documentation.gravitee.io/apim/release-information/changelog
🔗
License
https://github.com/gravitee-io/gravitee-api-management/blob/master/LICENSE.txt
🔗
SDKs
https://github.com/gravitee-io/gravitee-clients-sdk
🔗
SDKs
https://github.com/gravitee-io/terraform-provider-apim
🔗
CLI
https://github.com/gravitee-io/graviteeio-cli
🔗
KubernetesOperator
https://github.com/gravitee-io/gravitee-kubernetes-operator
🔗
HelmChart
https://github.com/gravitee-io/helm-charts
🔗
DockerImage
https://hub.docker.com/r/graviteeio/apim-gateway
🔗
JSONLDContext
https://raw.githubusercontent.com/api-evangelist/gravitee/refs/heads/main/json-ld/gravitee-context.jsonld
🔗
KubernetesCRD
https://raw.githubusercontent.com/api-evangelist/gravitee/refs/heads/main/crd/gravitee.io_apidefinitions.yaml
🔗
KubernetesCRD
https://raw.githubusercontent.com/api-evangelist/gravitee/refs/heads/main/crd/gravitee.io_apiv4definitions.yaml
🔗
KubernetesCRD
https://raw.githubusercontent.com/api-evangelist/gravitee/refs/heads/main/crd/gravitee.io_apiresources.yaml
🔗
KubernetesCRD
https://raw.githubusercontent.com/api-evangelist/gravitee/refs/heads/main/crd/gravitee.io_applications.yaml
🔗
KubernetesCRD
https://raw.githubusercontent.com/api-evangelist/gravitee/refs/heads/main/crd/gravitee.io_subscriptions.yaml
🔗
KubernetesCRD
https://raw.githubusercontent.com/api-evangelist/gravitee/refs/heads/main/crd/gravitee.io_managementcontexts.yaml
🔗
KubernetesCRD
https://raw.githubusercontent.com/api-evangelist/gravitee/refs/heads/main/crd/gravitee.io_sharedpolicygroups.yaml
🔗
KubernetesCRD
https://raw.githubusercontent.com/api-evangelist/gravitee/refs/heads/main/crd/gravitee.io_groups.yaml
🔗
KubernetesCRD
https://raw.githubusercontent.com/api-evangelist/gravitee/refs/heads/main/crd/gravitee.io_notifications.yaml
🔗
Plans
https://raw.githubusercontent.com/api-evangelist/gravitee/refs/heads/main/plans/gravitee-plans-pricing.yml
🔗
FinOps
https://raw.githubusercontent.com/api-evangelist/gravitee/refs/heads/main/finops/gravitee-finops.yml
🔗
Capabilities
https://raw.githubusercontent.com/api-evangelist/gravitee/refs/heads/main/capabilities/api-gateway-operations.yaml
🔗
Capabilities
https://raw.githubusercontent.com/api-evangelist/gravitee/refs/heads/main/capabilities/traffic-observability.yaml
🔗
GraphQL
https://raw.githubusercontent.com/api-evangelist/gravitee/refs/heads/main/graphql/gravitee-graphql.md
🔗
Reference
https://documentation.gravitee.io/am/reference/am-api-reference
🔗
ChangeLog
https://documentation.gravitee.io/am/releases-and-changelog/release-notes
🔗
License
https://github.com/gravitee-io/gravitee-access-management/blob/master/LICENSE
🔗
SDKs
https://github.com/gravitee-io/gravitee-access-management/tree/master/gravitee-am-management-api-sdk-java
🔗
HelmChart
https://github.com/gravitee-io/helm-charts/tree/master/helm/gravitee-am
🔗
DockerImage
https://hub.docker.com/r/graviteeio/am-gateway
🔗
Capabilities
https://raw.githubusercontent.com/api-evangelist/gravitee/refs/heads/main/capabilities/access-management.yaml

OpenAPI Specification

gravitee-organizations-api-openapi.yml Raw ↑ 
openapi: 3.0.1
info:
  title: Gravitee.io - Access Management alerts Organizations API
  version: 4.12.0-alpha.3
servers:
- url: /management
security:
- gravitee-auth: []
tags:
- name: Organizations
paths:
  /organizations/{organizationId}/environments:
    get:
      summary: List all the environments
      description: User must have the ENVIRONMENT[LIST] permission on the specified organization AND either ENVIRONMENT[READ] permission on each environment or ENVIRONMENT[READ] permission on the specified organization.Each returned environment is filtered and contains only basic information such as id and name.
      operationId: listEnvironments
      parameters:
      - name: organizationId
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: List all the environments of the organization
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/Environment'
        '500':
          description: Internal server error
      tags:
      - Organizations
  /organizations/{organizationId}/environments/{environmentId}/members/permissions:
    get:
      summary: List environment member's permissions
      description: User must have ENVIRONMENT[READ] permission on the specified environment or ENVIRONMENT[READ] permission on the specified organization
      operationId: getMemberPermissions
      parameters:
      - name: organizationId
        in: path
        required: true
        schema:
          type: string
      - name: environmentId
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Environment member's permissions
          content:
            application/json:
              schema:
                type: string
        '500':
          description: Internal server error
      tags:
      - Organizations
  /organizations/{organizationId}/members:
    get:
      summary: List members for an organization
      description: User must have ORGANIZATION_MEMBER[LIST] permission on the specified organization
      operationId: listOrganizationMembers
      parameters:
      - name: organizationId
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: List members for an organization
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MembershipListItem'
        '500':
          description: Internal server error
      tags:
      - Organizations
    post:
      summary: Add or update an organization member
      description: User must have ORGANIZATION_MEMBER[READ] permission on the specified organization
      operationId: addOrUpdateOrganizationMember
      parameters:
      - name: organizationId
        in: path
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/NewMembership'
        required: true
      responses:
        '201':
          description: Member has been added or updated successfully
        '400':
          description: Membership parameter is not valid
        '500':
          description: Internal server error
      tags:
      - Organizations
  /organizations/{organizationId}/members/{member}:
    delete:
      summary: Remove a membership of the organization
      description: User must have ORGANIZATION_MEMBER[DELETE] permission on the specified organization
      operationId: removeOrganizationMember
      parameters:
      - name: organizationId
        in: path
        required: true
        schema:
          type: string
      - name: member
        in: path
        required: true
        schema:
          type: string
      responses:
        '204':
          description: Membership successfully deleted
        '500':
          description: Internal server error
      tags:
      - Organizations
  /organizations/{organizationId}/settings:
    get:
      summary: Get organization main settings
      description: User must have the ORGANIZATION_SETTINGS[READ] permission on the specified organization
      operationId: getOrganizationSettings
      parameters:
      - name: organizationId
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Platform settings successfully fetched
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Domain'
        '500':
          description: Internal server error
      tags:
      - Organizations
    patch:
      summary: Update platform main settings
      description: User must have the ORGANIZATION_SETTINGS[UPDATE] permission on the specified organization
      operationId: patchOrganizationSettings
      parameters:
      - name: organizationId
        in: path
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PatchOrganization'
        required: true
      responses:
        '200':
          description: Platform settings successfully patched
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Domain'
        '500':
          description: Internal server error
      tags:
      - Organizations
components:
  schemas:
    PatchOrganization:
      type: object
      properties:
        identities:
          type: array
          writeOnly: true
          items:
            type: string
    LoginSettings:
      type: object
      properties:
        certificateBasedAuthEnabled:
          type: boolean
        certificateBasedAuthUrl:
          type: string
        enforcePasswordPolicyEnabled:
          type: boolean
        forgotPasswordEnabled:
          type: boolean
        hideForm:
          type: boolean
        identifierFirstEnabled:
          type: boolean
        inherited:
          type: boolean
        magicLinkAuthEnabled:
          type: boolean
        passwordlessDeviceNamingEnabled:
          type: boolean
        passwordlessEnabled:
          type: boolean
        passwordlessEnforcePasswordEnabled:
          type: boolean
        passwordlessEnforcePasswordMaxAge:
          type: integer
          format: int32
        passwordlessRememberDeviceEnabled:
          type: boolean
        registerEnabled:
          type: boolean
        rememberMeEnabled:
          type: boolean
        resetPasswordOnExpiration:
          type: boolean
    MembershipListItem:
      type: object
      properties:
        memberships:
          type: array
          items:
            $ref: '#/components/schemas/Membership'
        metadata:
          type: object
          additionalProperties:
            type: object
            additionalProperties:
              type: object
    CertificateSettings:
      type: object
      properties:
        fallbackCertificate:
          type: string
    Environment:
      type: object
      properties:
        createdAt:
          type: string
          format: date-time
        description:
          type: string
        domainRestrictions:
          type: array
          items:
            type: string
        hrids:
          type: array
          items:
            type: string
        id:
          type: string
        name:
          type: string
        organizationId:
          type: string
        updatedAt:
          type: string
          format: date-time
    SAMLSettings:
      type: object
      properties:
        certificate:
          type: string
        enabled:
          type: boolean
        entityId:
          type: string
    SCIMSettings:
      type: object
      properties:
        enabled:
          type: boolean
        idpSelectionEnabled:
          type: boolean
        idpSelectionRule:
          type: string
    TokenExchangeSettings:
      type: object
      properties:
        allowDelegation:
          type: boolean
        allowImpersonation:
          type: boolean
        allowedActorTokenTypes:
          type: array
          items:
            type: string
        allowedRequestedTokenTypes:
          type: array
          items:
            type: string
        allowedSubjectTokenTypes:
          type: array
          items:
            type: string
        enabled:
          type: boolean
        maxDelegationDepth:
          type: integer
          format: int32
        tokenExchangeOAuthSettings:
          $ref: '#/components/schemas/TokenExchangeOAuthSettings'
        trustedIssuers:
          type: array
          items:
            $ref: '#/components/schemas/TrustedIssuer'
    CIBASettings:
      type: object
      properties:
        authReqExpiry:
          type: integer
          format: int32
        bindingMessageLength:
          type: integer
          format: int32
        deviceNotifiers:
          type: array
          items:
            $ref: '#/components/schemas/CIBASettingNotifier'
        enabled:
          type: boolean
        tokenReqInterval:
          type: integer
          format: int32
    CIMDSettings:
      type: object
      properties:
        allowPrivateIpAddress:
          type: boolean
        allowUnsecuredHttpUri:
          type: boolean
        allowedDomains:
          type: array
          items:
            type: string
        cacheMaxEntries:
          type: integer
          format: int32
        cacheTtlSeconds:
          type: integer
          format: int32
        enabled:
          type: boolean
        fetchTimeoutMs:
          type: integer
          format: int32
        maxResponseSizeKb:
          type: integer
          format: int32
        revokeOnDocumentChange:
          type: boolean
        templateId:
          type: string
    AccountSettings:
      type: object
      properties:
        accountBlockedDuration:
          type: integer
          format: int32
        autoLoginAfterRegistration:
          type: boolean
        autoLoginAfterResetPassword:
          type: boolean
        botDetectionPlugin:
          type: string
        completeRegistrationWhenResetPassword:
          type: boolean
        defaultIdentityProviderForRegistration:
          type: string
        deletePasswordlessDevicesAfterResetPassword:
          type: boolean
        dynamicUserRegistration:
          type: boolean
        inherited:
          type: boolean
        loginAttemptsDetectionEnabled:
          type: boolean
        loginAttemptsResetTime:
          type: integer
          format: int32
        maxLoginAttempts:
          type: integer
          format: int32
        mfaChallengeAttemptsDetectionEnabled:
          type: boolean
        mfaChallengeAttemptsResetTime:
          type: integer
          format: int32
        mfaChallengeMaxAttempts:
          type: integer
          format: int32
        mfaChallengeSendVerifyAlertEmail:
          type: boolean
        redirectUriAfterRegistration:
          type: string
        redirectUriAfterResetPassword:
          type: string
        rememberMe:
          type: boolean
        rememberMeDuration:
          type: integer
          format: int32
        resetPasswordConfirmIdentity:
          type: boolean
        resetPasswordCustomForm:
          type: boolean
        resetPasswordCustomFormFields:
          type: array
          items:
            $ref: '#/components/schemas/FormField'
        resetPasswordInvalidateTokens:
          type: boolean
        sendRecoverAccountEmail:
          type: boolean
        sendVerifyRegistrationAccountEmail:
          type: boolean
        useBotDetection:
          type: boolean
    FormField:
      type: object
      properties:
        key:
          type: string
        label:
          type: string
        type:
          type: string
    SecretExpirationSettings:
      type: object
      properties:
        enabled:
          type: boolean
        expiryTimeSeconds:
          type: integer
          format: int64
    VirtualHost:
      type: object
      properties:
        host:
          type: string
        overrideEntrypoint:
          type: boolean
        path:
          type: string
    SelfServiceAccountManagementSettings:
      type: object
      properties:
        enabled:
          type: boolean
        resetPassword:
          $ref: '#/components/schemas/ResetPasswordSettings'
    ClientRegistrationSettings:
      type: object
      properties:
        allowHttpSchemeRedirectUri:
          type: boolean
        allowLocalhostRedirectUri:
          type: boolean
        allowRedirectUriParamsExpressionLanguage:
          type: boolean
        allowWildCardRedirectUri:
          type: boolean
        allowedScopes:
          type: array
          items:
            type: string
        allowedScopesEnabled:
          type: boolean
        clientTemplateEnabled:
          type: boolean
        defaultScopes:
          type: array
          items:
            type: string
        dynamicClientRegistrationEnabled:
          type: boolean
        openDynamicClientRegistrationEnabled:
          type: boolean
    WebAuthnSettings:
      type: object
      properties:
        attestationConveyancePreference:
          type: string
          enum:
          - NONE
          - INDIRECT
          - DIRECT
        authenticatorAttachment:
          type: string
          enum:
          - CROSS_PLATFORM
          - PLATFORM
        certificates:
          type: object
          additionalProperties:
            type: object
        enforceAuthenticatorIntegrity:
          type: boolean
        enforceAuthenticatorIntegrityMaxAge:
          type: integer
          format: int32
        forceRegistration:
          type: boolean
        origin:
          type: string
        relyingPartyId:
          type: string
        relyingPartyName:
          type: string
        requireResidentKey:
          type: boolean
        userVerification:
          type: string
          enum:
          - REQUIRED
          - PREFERRED
          - DISCOURAGED
    TrustedIssuer:
      type: object
      properties:
        certificate:
          type: string
        issuer:
          type: string
        jwksUri:
          type: string
        keyResolutionMethod:
          type: string
          enum:
          - JWKS_URL
          - PEM
        scopeMappings:
          type: object
          additionalProperties:
            type: string
        userBindingCriteria:
          type: array
          items:
            $ref: '#/components/schemas/UserBindingCriterion'
        userBindingEnabled:
          type: boolean
    PasswordSettings:
      type: object
      properties:
        excludePasswordsInDictionary:
          type: boolean
        excludeUserProfileInfoInPassword:
          type: boolean
        expiryDuration:
          type: integer
          format: int32
        includeNumbers:
          type: boolean
        includeSpecialCharacters:
          type: boolean
        inherited:
          type: boolean
        lettersInMixedCase:
          type: boolean
        maxConsecutiveLetters:
          type: integer
          format: int32
        maxLength:
          type: integer
          format: int32
        minLength:
          type: integer
          format: int32
        oldPasswords:
          type: integer
          format: int32
        passwordHistoryEnabled:
          type: boolean
    Domain:
      type: object
      properties:
        accountSettings:
          $ref: '#/components/schemas/AccountSettings'
        alertEnabled:
          type: boolean
        certificateSettings:
          $ref: '#/components/schemas/CertificateSettings'
        corsSettings:
          $ref: '#/components/schemas/CorsSettings'
        createdAt:
          type: string
          format: date-time
        dataPlaneId:
          type: string
        description:
          type: string
        dynamicClientRegistrationEnabled:
          type: boolean
        dynamicClientRegistrationTemplateEnabled:
          type: boolean
        enabled:
          type: boolean
        hrid:
          type: string
        id:
          type: string
        identities:
          uniqueItems: true
          type: array
          items:
            type: string
        loginSettings:
          $ref: '#/components/schemas/LoginSettings'
        master:
          type: boolean
        name:
          type: string
        oidc:
          $ref: '#/components/schemas/OIDCSettings'
        openDynamicClientRegistrationEnabled:
          type: boolean
        passwordSettings:
          $ref: '#/components/schemas/PasswordSettings'
        path:
          type: string
        redirectUriExpressionLanguageEnabled:
          type: boolean
        redirectUriLocalhostAllowed:
          type: boolean
        redirectUriStrictMatching:
          type: boolean
        redirectUriUnsecuredHttpSchemeAllowed:
          type: boolean
        redirectUriWildcardAllowed:
          type: boolean
        referenceId:
          type: string
        referenceType:
          type: string
          enum:
          - PLATFORM
          - DOMAIN
          - APPLICATION
          - ORGANIZATION
          - ENVIRONMENT
          - PROTECTED_RESOURCE
        saml:
          $ref: '#/components/schemas/SAMLSettings'
        scim:
          $ref: '#/components/schemas/SCIMSettings'
        secretExpirationSettings:
          $ref: '#/components/schemas/SecretExpirationSettings'
        selfServiceAccountManagementSettings:
          $ref: '#/components/schemas/SelfServiceAccountManagementSettings'
        tags:
          uniqueItems: true
          type: array
          items:
            type: string
        tokenExchangeSettings:
          $ref: '#/components/schemas/TokenExchangeSettings'
        uma:
          $ref: '#/components/schemas/UMASettings'
        updatedAt:
          type: string
          format: date-time
        version:
          type: string
          enum:
          - V1_0
          - V2_0
        vhostMode:
          type: boolean
        vhosts:
          type: array
          items:
            $ref: '#/components/schemas/VirtualHost'
        webAuthnSettings:
          $ref: '#/components/schemas/WebAuthnSettings'
    Membership:
      type: object
      properties:
        createdAt:
          type: string
          format: date-time
        domain:
          type: string
        fromRoleMapper:
          type: boolean
        id:
          type: string
        memberId:
          type: string
        memberType:
          type: string
          enum:
          - USER
          - GROUP
        referenceId:
          type: string
        referenceType:
          type: string
          enum:
          - PLATFORM
          - DOMAIN
          - APPLICATION
          - ORGANIZATION
          - ENVIRONMENT
          - PROTECTED_RESOURCE
        roleId:
          type: string
        updatedAt:
          type: string
          format: date-time
    NewMembership:
      required:
      - memberId
      - memberType
      - role
      type: object
      properties:
        memberId:
          type: string
        memberType:
          type: string
          enum:
          - USER
          - GROUP
        role:
          type: string
    UserBindingCriterion:
      type: object
      properties:
        attribute:
          type: string
        expression:
          type: string
    OIDCSettings:
      type: object
      properties:
        cibaSettings:
          $ref: '#/components/schemas/CIBASettings'
        cimdSettings:
          $ref: '#/components/schemas/CIMDSettings'
        clientRegistrationSettings:
          $ref: '#/components/schemas/ClientRegistrationSettings'
        postLogoutRedirectUris:
          type: array
          items:
            type: string
        redirectUriStrictMatching:
          type: boolean
        requestUris:
          type: array
          items:
            type: string
        securityProfileSettings:
          $ref: '#/components/schemas/SecurityProfileSettings'
    ResetPasswordSettings:
      type: object
      properties:
        oldPasswordRequired:
          type: boolean
        tokenAge:
          type: integer
          format: int32
    SecurityProfileSettings:
      type: object
      properties:
        enableFapiBrazil:
          type: boolean
        enablePlainFapi:
          type: boolean
    CorsSettings:
      type: object
      properties:
        allowCredentials:
          type: boolean
        allowedHeaders:
          uniqueItems: true
          type: array
          items:
            type: string
        allowedMethods:
          uniqueItems: true
          type: array
          items:
            type: string
        allowedOrigins:
          uniqueItems: true
          type: array
          items:
            type: string
        enabled:
          type: boolean
        maxAge:
          type: integer
          format: int32
    CIBASettingNotifier:
      type: object
      properties:
        id:
          type: string
    UMASettings:
      type: object
      properties:
        enabled:
          type: boolean
    TokenExchangeOAuthSettings:
      type: object
      properties:
        inherited:
          type: boolean
        scopeHandling:
          type: string
          enum:
          - DOWNSCOPING
          - PERMISSIVE
  securitySchemes:
    gravitee-auth:
      type: http
      scheme: Bearer