Gravitee

Gravitee Current User API

The Current User API from Gravitee — 12 operation(s) for current user.

GitHub OpenAPI

Operations 16

GET /organizations/{orgId}/environments/{envId}/user Get the authenticated user #
PUT /organizations/{orgId}/environments/{envId}/user Update the authenticated user #
DELETE /organizations/{orgId}/environments/{envId}/user Delete the current logged user #
GET /organizations/{orgId}/environments/{envId}/user/avatar Get user's avatar #
POST /organizations/{orgId}/environments/{envId}/user/login Login #
POST /organizations/{orgId}/environments/{envId}/user/logout Logout #
GET /organizations/{orgId}/environments/{envId}/user/tags Get the user's allowed sharding tags #
GET /organizations/{orgId}/environments/{envId}/user/tasks Get the user's tasks #
GET /organizations/{orgId}/user Get the authenticated user #
PUT /organizations/{orgId}/user Update the authenticated user #
DELETE /organizations/{orgId}/user Delete the current logged user #
GET /organizations/{orgId}/user/avatar Get user's avatar #
POST /organizations/{orgId}/user/login Login #
POST /organizations/{orgId}/user/logout Logout #
GET /organizations/{orgId}/user/tags Get the user's allowed sharding tags #
GET /organizations/{orgId}/user/tasks Get the user's tasks #

Documentation

📖
Documentation
https://documentation.gravitee.io/apim
📖
GettingStarted
https://documentation.gravitee.io/apim/getting-started
📖
RateLimits
https://artifacts.apis.io/gravitee/rate-limits/gravitee-rate-limits.yml
📖
Documentation
https://documentation.gravitee.io/am

Specifications

⚙
OpenAPI
https://artifacts.apis.io/gravitee/openapi/gravitee-current-user-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://artifacts.apis.io/gravitee/json-schema/gravitee-api-schema.json
📊
JSONSchema
https://artifacts.apis.io/gravitee/json-schema/gravitee-plan-schema.json
📊
JSONSchema
https://artifacts.apis.io/gravitee/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://artifacts.apis.io/gravitee/json-ld/gravitee-context.jsonld
🔗
KubernetesCRD
https://artifacts.apis.io/gravitee/crd/gravitee.io_apidefinitions.yaml
🔗
KubernetesCRD
https://artifacts.apis.io/gravitee/crd/gravitee.io_apiv4definitions.yaml
🔗
KubernetesCRD
https://artifacts.apis.io/gravitee/crd/gravitee.io_apiresources.yaml
🔗
KubernetesCRD
https://artifacts.apis.io/gravitee/crd/gravitee.io_applications.yaml
🔗
KubernetesCRD
https://artifacts.apis.io/gravitee/crd/gravitee.io_subscriptions.yaml
🔗
KubernetesCRD
https://artifacts.apis.io/gravitee/crd/gravitee.io_managementcontexts.yaml
🔗
KubernetesCRD
https://artifacts.apis.io/gravitee/crd/gravitee.io_sharedpolicygroups.yaml
🔗
KubernetesCRD
https://artifacts.apis.io/gravitee/crd/gravitee.io_groups.yaml
🔗
KubernetesCRD
https://artifacts.apis.io/gravitee/crd/gravitee.io_notifications.yaml
🔗
Plans
https://artifacts.apis.io/gravitee/plans/gravitee-plans-pricing.yml
🔗
FinOps
https://artifacts.apis.io/gravitee/finops/gravitee-finops.yml
🔗
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

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API 
curl "https://apis.io/api/v1/apis/gravitee:gravitee-current-user-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

gravitee-current-user-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: Gravitee.io - Management Current User API
  description: Some news resources are in alpha version. This implies that they are likely to be modified or even removed in future versions. They are marked with the 🧪 symbol
  version: 3.20.0
servers:
- url: http://localhost:8083/management
security:
- gravitee-auth: []
tags:
- name: Current User
paths:
  /organizations/{orgId}/environments/{envId}/user:
    get:
      tags:
      - Current User
      summary: Get the authenticated user
      operationId: getCurrentUser_1
      parameters:
      - name: envId
        in: path
        description: The ID of the environment
        required: true
        schema:
          type: string
          default: DEFAULT
      - name: orgId
        in: path
        description: The ID of the Organization
        required: true
        schema:
          type: string
          default: DEFAULT
      responses:
        '200':
          description: Authenticated user
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UserDetails'
        '401':
          description: Unauthorized user
        '500':
          description: Internal server error
    put:
      tags:
      - Current User
      summary: Update the authenticated user
      operationId: updateCurrentUser_1
      parameters:
      - name: envId
        in: path
        description: The ID of the environment
        required: true
        schema:
          type: string
          default: DEFAULT
      - name: orgId
        in: path
        description: The ID of the Organization
        required: true
        schema:
          type: string
          default: DEFAULT
      requestBody:
        content:
          '*/*':
            schema:
              $ref: '#/components/schemas/UpdateUserEntity'
        required: true
      responses:
        '200':
          description: Updated user
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UserEntity'
        '400':
          description: Invalid user profile
        '404':
          description: User not found
        '500':
          description: Internal server error
    delete:
      tags:
      - Current User
      summary: Delete the current logged user
      operationId: deleteCurrentUser_1
      parameters:
      - name: envId
        in: path
        description: The ID of the environment
        required: true
        schema:
          type: string
          default: DEFAULT
      - name: orgId
        in: path
        description: The ID of the Organization
        required: true
        schema:
          type: string
          default: DEFAULT
      responses:
        '204':
          description: Current user successfully deleted
        '401':
          description: Unauthorized
        '500':
          description: Internal server error
  /organizations/{orgId}/environments/{envId}/user/avatar:
    get:
      tags:
      - Current User
      summary: Get user's avatar
      operationId: getCurrentUserPicture_1
      parameters:
      - name: envId
        in: path
        description: The ID of the environment
        required: true
        schema:
          type: string
          default: DEFAULT
      - name: orgId
        in: path
        description: The ID of the Organization
        required: true
        schema:
          type: string
          default: DEFAULT
      responses:
        '200':
          description: User's avatar
          content:
            '*/*':
              schema:
                type: string
                format: binary
        '404':
          description: User not found
        '500':
          description: Internal server error
  /organizations/{orgId}/environments/{envId}/user/login:
    post:
      tags:
      - Current User
      summary: Login
      operationId: login_1
      parameters:
      - name: envId
        in: path
        description: The ID of the environment
        required: true
        schema:
          type: string
          default: DEFAULT
      - name: orgId
        in: path
        description: The ID of the Organization
        required: true
        schema:
          type: string
          default: DEFAULT
      responses:
        default:
          description: default response
          content:
            application/json: {}
  /organizations/{orgId}/environments/{envId}/user/logout:
    post:
      tags:
      - Current User
      summary: Logout
      operationId: logoutCurrentUser_1
      parameters:
      - name: envId
        in: path
        description: The ID of the environment
        required: true
        schema:
          type: string
          default: DEFAULT
      - name: orgId
        in: path
        description: The ID of the Organization
        required: true
        schema:
          type: string
          default: DEFAULT
      responses:
        default:
          description: default response
          content:
            '*/*': {}
  /organizations/{orgId}/environments/{envId}/user/tags:
    get:
      tags:
      - Current User
      summary: Get the user's allowed sharding tags
      operationId: getUserShardingTags_1
      parameters:
      - name: envId
        in: path
        description: The ID of the environment
        required: true
        schema:
          type: string
          default: DEFAULT
      - name: orgId
        in: path
        description: The ID of the Organization
        required: true
        schema:
          type: string
          default: DEFAULT
      responses:
        '200':
          description: User's sharding tags
          content:
            application/json:
              schema:
                uniqueItems: true
                type: array
                items:
                  type: string
        '404':
          description: User not found
        '500':
          description: Internal server error
  /organizations/{orgId}/environments/{envId}/user/tasks:
    get:
      tags:
      - Current User
      summary: Get the user's tasks
      operationId: getUserTasks_1
      parameters:
      - name: envId
        in: path
        description: The ID of the environment
        required: true
        schema:
          type: string
          default: DEFAULT
      - name: orgId
        in: path
        description: The ID of the Organization
        required: true
        schema:
          type: string
          default: DEFAULT
      responses:
        '200':
          description: User's tasks
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TaskEntityPagedResult'
        '404':
          description: User not found
        '500':
          description: Internal server error
  /organizations/{orgId}/user:
    get:
      tags:
      - Current User
      summary: Get the authenticated user
      operationId: getCurrentUser
      parameters:
      - name: orgId
        in: path
        description: The ID of the Organization
        required: true
        schema:
          type: string
          default: DEFAULT
      responses:
        '200':
          description: Authenticated user
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UserDetails'
        '401':
          description: Unauthorized user
        '500':
          description: Internal server error
    put:
      tags:
      - Current User
      summary: Update the authenticated user
      operationId: updateCurrentUser
      parameters:
      - name: orgId
        in: path
        description: The ID of the Organization
        required: true
        schema:
          type: string
          default: DEFAULT
      requestBody:
        content:
          '*/*':
            schema:
              $ref: '#/components/schemas/UpdateUserEntity'
        required: true
      responses:
        '200':
          description: Updated user
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UserEntity'
        '400':
          description: Invalid user profile
        '404':
          description: User not found
        '500':
          description: Internal server error
    delete:
      tags:
      - Current User
      summary: Delete the current logged user
      operationId: deleteCurrentUser
      parameters:
      - name: orgId
        in: path
        description: The ID of the Organization
        required: true
        schema:
          type: string
          default: DEFAULT
      responses:
        '204':
          description: Current user successfully deleted
        '401':
          description: Unauthorized
        '500':
          description: Internal server error
  /organizations/{orgId}/user/avatar:
    get:
      tags:
      - Current User
      summary: Get user's avatar
      operationId: getCurrentUserPicture
      parameters:
      - name: orgId
        in: path
        description: The ID of the Organization
        required: true
        schema:
          type: string
          default: DEFAULT
      responses:
        '200':
          description: User's avatar
          content:
            '*/*':
              schema:
                type: string
                format: binary
        '404':
          description: User not found
        '500':
          description: Internal server error
  /organizations/{orgId}/user/login:
    post:
      tags:
      - Current User
      summary: Login
      operationId: login
      parameters:
      - name: orgId
        in: path
        description: The ID of the Organization
        required: true
        schema:
          type: string
          default: DEFAULT
      responses:
        default:
          description: default response
          content:
            application/json: {}
  /organizations/{orgId}/user/logout:
    post:
      tags:
      - Current User
      summary: Logout
      operationId: logoutCurrentUser
      parameters:
      - name: orgId
        in: path
        description: The ID of the Organization
        required: true
        schema:
          type: string
          default: DEFAULT
      responses:
        default:
          description: default response
          content:
            '*/*': {}
  /organizations/{orgId}/user/tags:
    get:
      tags:
      - Current User
      summary: Get the user's allowed sharding tags
      operationId: getUserShardingTags
      parameters:
      - name: orgId
        in: path
        description: The ID of the Organization
        required: true
        schema:
          type: string
          default: DEFAULT
      responses:
        '200':
          description: User's sharding tags
          content:
            application/json:
              schema:
                uniqueItems: true
                type: array
                items:
                  type: string
        '404':
          description: User not found
        '500':
          description: Internal server error
  /organizations/{orgId}/user/tasks:
    get:
      tags:
      - Current User
      summary: Get the user's tasks
      operationId: getUserTasks
      parameters:
      - name: orgId
        in: path
        description: The ID of the Organization
        required: true
        schema:
          type: string
          default: DEFAULT
      responses:
        '200':
          description: User's tasks
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TaskEntityPagedResult'
        '404':
          description: User not found
        '500':
          description: Internal server error
components:
  schemas:
    GrantedAuthority:
      type: object
      properties:
        authority:
          type: string
    Page:
      type: object
      properties:
        current:
          type: integer
          format: int32
        per_page:
          type: integer
          format: int32
        size:
          type: integer
          format: int32
        total_elements:
          type: integer
          format: int32
        total_pages:
          type: integer
          format: int32
    UserDetails:
      type: object
      properties:
        authorities:
          type: array
          items:
            $ref: '#/components/schemas/GrantedAuthority'
        created_at:
          type: string
          format: date-time
        customFields:
          type: object
          additionalProperties:
            type: object
        displayName:
          type: string
        displayNewsletterSubscription:
          type: boolean
        email:
          type: string
        enabled:
          type: boolean
        firstLogin:
          type: boolean
        firstname:
          type: string
        groupsByEnvironment:
          type: object
          additionalProperties:
            uniqueItems: true
            type: array
            items:
              type: string
        id:
          type: string
        last_connection_at:
          type: string
          format: date-time
        lastname:
          type: string
        picture:
          type: array
          items:
            type: string
            format: byte
        primaryOwner:
          type: boolean
        roles:
          type: array
          items:
            $ref: '#/components/schemas/UserDetailRole'
        source:
          type: string
        sourceId:
          type: string
        system:
          type: boolean
        updated_at:
          type: string
          format: date-time
    UserRoleEntity:
      type: object
      properties:
        id:
          type: string
        name:
          type: string
        permissions:
          type: object
          additionalProperties:
            type: array
            items:
              type: string
        scope:
          $ref: '#/components/schemas/RoleScope'
    UpdateUserEntity:
      type: object
      properties:
        customFields:
          type: object
          additionalProperties:
            type: object
        email:
          type: string
        firstname:
          type: string
        lastname:
          type: string
        newsletter:
          type: boolean
        picture:
          type: string
        status:
          type: string
    TaskEntityPagedResult:
      type: object
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/TaskEntity'
        metadata:
          type: object
          additionalProperties:
            type: object
            additionalProperties:
              type: object
        page:
          $ref: '#/components/schemas/Page'
    TaskEntity:
      type: object
      properties:
        created_at:
          type: string
          format: date-time
        data:
          type: object
        type:
          $ref: '#/components/schemas/TaskType'
    UserDetailRole:
      type: object
      properties:
        name:
          type: string
        permissions:
          type: object
          additionalProperties:
            type: array
            items:
              type: string
        scope:
          type: string
    UserEntity:
      type: object
      properties:
        created_at:
          type: string
          format: date-time
        customFields:
          type: object
          additionalProperties:
            type: object
        displayName:
          type: string
          readOnly: true
        email:
          type: string
        envRoles:
          type: object
          additionalProperties:
            uniqueItems: true
            type: array
            items:
              $ref: '#/components/schemas/UserRoleEntity'
        firstConnectionAt:
          type: string
          format: date-time
        firstname:
          type: string
        id:
          type: string
        lastConnectionAt:
          type: string
          format: date-time
        lastname:
          type: string
        loginCount:
          type: integer
          format: int64
        newsletterSubscribed:
          type: boolean
        number_of_active_tokens:
          type: integer
          format: int32
        password:
          type: string
        picture:
          type: string
        primary_owner:
          type: boolean
        roles:
          uniqueItems: true
          type: array
          items:
            $ref: '#/components/schemas/UserRoleEntity'
        source:
          type: string
        sourceId:
          type: string
        status:
          type: string
        updated_at:
          type: string
          format: date-time
    TaskType:
      type: string
      enum:
      - SUBSCRIPTION_APPROVAL
      - IN_REVIEW
      - REQUEST_FOR_CHANGES
      - USER_REGISTRATION_APPROVAL
      - PROMOTION_APPROVAL
    RoleScope:
      type: string
      enum:
      - API
      - APPLICATION
      - GROUP
      - ENVIRONMENT
      - ORGANIZATION
      - PLATFORM
  securitySchemes:
    gravitee-auth:
      type: http
      scheme: basic