Stardog

Stardog Users API

Operations on system users

GitHub OpenAPI

Operations 14

GET /admin/users List users #
POST /admin/users Add user #
GET /admin/users/{user}/superuser User is Superuser #
GET /admin/users/{user}/enabled User enabled #
PUT /admin/users/{user}/enabled Enable/Disable User #
PUT /admin/users/{user}/pwd Change user's password #
GET /admin/users/{user}/roles Get user's roles #
PUT /admin/users/{user}/roles Set user's roles #
POST /admin/users/{user}/roles Add role to user #
DELETE /admin/users/{user}/roles/{role} Remove role from user #
GET /admin/users/{user}/auto_created User auto-created #
GET /admin/users/list List users with attributes, roles and permissions #
GET /admin/users/{user} Get User #
DELETE /admin/users/{user} Delete User #

Specifications

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

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/stardog-users-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

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

stardog-users-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: Stardog HTTP Users API
  description: '# Overview

    Stardog supports the standard SPARQL Protocol HTTP bindings, as well as additional functionality via HTTP.'
  contact:
    url: https://stardog.com
  license:
    name: Apache 2.0
    url: http://www.apache.org/licenses/LICENSE-2.0
  version: 12.0.3
  x-logo:
    url: https://d33wubrfki0l68.cloudfront.net/66e9dcff51317cfc11b9f3d4ce2917a11ba81681/543c1/img/stardog-logo-optimized.svg
servers:
- url: http://localhost:5820
tags:
- name: Users
  description: Operations on system users
paths:
  /admin/users:
    get:
      tags:
      - Users
      summary: List users
      operationId: listUsers
      responses:
        '200':
          $ref: '#/components/responses/USER_LIST'
    post:
      tags:
      - Users
      summary: Add user
      operationId: addUser
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/USER_CREATE'
      responses:
        '201':
          description: User created
        '400':
          $ref: '#/components/responses/MALFORMED_REQUEST_400'
  /admin/users/{user}/superuser:
    get:
      tags:
      - Users
      summary: User is Superuser
      description: Return whether or not a user is a Superuser
      operationId: isSuper
      parameters:
      - name: user
        $ref: '#/components/parameters/user'
      responses:
        '200':
          description: Operation successful
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SUPERUSER'
        '404':
          description: User does not exist
          content:
            application/json:
              schema:
                required:
                - message
                - code
                properties:
                  message:
                    type: string
                    example: User does not exist
                  code:
                    type: string
                    example: SERNF2
  /admin/users/{user}/enabled:
    get:
      tags:
      - Users
      summary: User enabled
      description: Return whether or not a user is enabled (active) in the system
      operationId: userEnabled
      parameters:
      - name: user
        $ref: '#/components/parameters/user'
      responses:
        '200':
          description: Operation successful
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ENABLED'
        '404':
          description: User does not exist
          content:
            application/json:
              schema:
                required:
                - message
                - code
                properties:
                  message:
                    type: string
                    example: User does not exist
                  code:
                    type: string
                    example: SERNF2
    put:
      tags:
      - Users
      summary: Enable/Disable User
      operationId: setUserEnabled
      parameters:
      - name: user
        $ref: '#/components/parameters/user'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ENABLED'
        required: true
      responses:
        '200':
          description: Flag set
        '400':
          $ref: '#/components/responses/MALFORMED_REQUEST_400'
        '404':
          description: User does not exist
          content:
            application/json:
              schema:
                required:
                - message
                - code
                properties:
                  message:
                    type: string
                    example: User does not exist
                  code:
                    type: string
                    example: SERNF2
  /admin/users/{user}/pwd:
    put:
      tags:
      - Users
      summary: Change user's password
      operationId: changePassword
      parameters:
      - name: user
        $ref: '#/components/parameters/user'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/USER_PASSWD'
        required: true
      responses:
        '200':
          description: Password successfully changed
        '400':
          $ref: '#/components/responses/MALFORMED_REQUEST_400'
        '404':
          description: User does not exist
          content:
            application/json:
              schema:
                required:
                - message
                - code
                properties:
                  message:
                    type: string
                    example: User does not exist
                  code:
                    type: string
                    example: SERNF2
  /admin/users/{user}/roles:
    get:
      tags:
      - Users
      summary: Get user's roles
      description: Retrieve a list of all roles explicitly assigned to a user
      operationId: getUserRoles
      parameters:
      - name: user
        $ref: '#/components/parameters/user'
      responses:
        '200':
          $ref: '#/components/responses/ROLE_LIST'
        '404':
          description: User does not exist
          content:
            application/json:
              schema:
                required:
                - message
                - code
                properties:
                  message:
                    type: string
                    example: User does not exist
                  code:
                    type: string
                    example: SERNF2
    put:
      tags:
      - Users
      summary: Set user's roles
      description: Overwrite the list of roles explicitly assigned to a user
      operationId: setUserRoles
      parameters:
      - name: user
        $ref: '#/components/parameters/user'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ROLE_LIST'
        required: true
      responses:
        '200':
          description: Roles successfully updated
        '400':
          $ref: '#/components/responses/MALFORMED_REQUEST_400'
        '404':
          description: User does not exist
          content:
            application/json:
              schema:
                required:
                - message
                - code
                properties:
                  message:
                    type: string
                    example: User does not exist
                  code:
                    type: string
                    example: SERNF2
    post:
      tags:
      - Users
      summary: Add role to user
      operationId: addUserRole
      parameters:
      - name: user
        $ref: '#/components/parameters/user'
      requestBody:
        $ref: '#/components/requestBodies/ROLENAME'
      responses:
        '204':
          description: Role successfully added
        '400':
          $ref: '#/components/responses/MALFORMED_REQUEST_400'
        '404':
          description: User does not exist
          content:
            application/json:
              schema:
                required:
                - message
                - code
                properties:
                  message:
                    type: string
                    example: User does not exist
                  code:
                    type: string
                    example: SERNF2
  /admin/users/{user}/roles/{role}:
    delete:
      tags:
      - Users
      summary: Remove role from user
      operationId: removeUserRole
      parameters:
      - name: user
        $ref: '#/components/parameters/user'
      - name: role
        $ref: '#/components/parameters/role'
      responses:
        '204':
          description: Role successfully removed
        '404':
          description: User/Role does not exist
          content:
            application/json:
              schema:
                required:
                - message
                - code
                properties:
                  message:
                    type: string
                    example: User does not exist
                  code:
                    type: string
                    example: SERNF2
  /admin/users/{user}/auto_created:
    get:
      tags:
      - Users
      summary: User auto-created
      description: Return whether a user was auto-created as a result the OAuth jwt authentication process
      operationId: userAutoCreated
      parameters:
      - name: user
        $ref: '#/components/parameters/user'
      responses:
        '200':
          description: Operation successful
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AUTO_CREATED'
        '404':
          description: User does not exist
          content:
            application/json:
              schema:
                required:
                - message
                - code
                properties:
                  message:
                    type: string
                    example: User does not exist
                  code:
                    type: string
                    example: SERNF2
  /admin/users/list:
    get:
      tags:
      - Users
      summary: List users with attributes, roles and permissions
      description: Retrieve a detailed list of all users, including their roles, permissions, and status
      operationId: listUsersDetailed
      responses:
        '200':
          $ref: '#/components/responses/USER_LIST_DETAILED'
  /admin/users/{user}:
    get:
      tags:
      - Users
      summary: Get User
      description: Retrieve attributes, roles, and permissions of a User
      operationId: getUser
      parameters:
      - name: user
        $ref: '#/components/parameters/user'
      responses:
        '200':
          description: Operation successful
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/USER'
        '404':
          description: User does not exist
          content:
            application/json:
              schema:
                required:
                - message
                - code
                properties:
                  message:
                    type: string
                    example: User does not exist
                  code:
                    type: string
                    example: SERNF2
    delete:
      tags:
      - Users
      summary: Delete User
      operationId: deleteUser
      parameters:
      - name: user
        $ref: '#/components/parameters/user'
      responses:
        '204':
          description: User deleted
        '404':
          description: User does not exist
          content:
            application/json:
              schema:
                required:
                - message
                - code
                properties:
                  message:
                    type: string
                    example: User does not exist
                  code:
                    type: string
                    example: SERNF2
components:
  schemas:
    USER_PASSWD:
      required:
      - password
      properties:
        password:
          type: string
    USER_LIST_DETAILED:
      type: array
      items:
        required:
        - username
        - enabled
        - superuser
        - roles
        - permissions
        properties:
          username:
            type: string
          enabled:
            type: boolean
          superuser:
            type: boolean
          roles:
            type: array
            items:
              type: string
          permissions:
            type: array
            items:
              $ref: '#/components/schemas/PERMISSION_WITH_EXPLICIT'
    PERMISSION_WITH_EXPLICIT:
      required:
      - action
      - resource_type
      - resource
      properties:
        action:
          type: string
          enum:
          - read
          - write
          - create
          - delete
          - revoke
          - grant
          - execute
          - all
        resource_type:
          type: string
          enum:
          - ALL
          - USER
          - ROLE
          - ROLE_ASSIGNMENT
          - PERMISSION
          - DATABASE
          - DATABASE_EXPORT
          - NAMED_GRAPH
          - DATA_SOURCE
          - VIRTUAL_GRAPH
          - DBMS_ADMIN
          - DATABASE_METADATA
          - DATABASE_ADMIN
          - DATABASE_MODELING
          - STORED_QUERY
          - CACHE
          - CACHE_TARGET
          - SENSITIVE_PROPERTIES
          - ENTITY_RESOLUTION
        resource:
          type: array
          items:
            type: string
        explicit:
          type: boolean
          description: Whether this permission is explicitly granted to the user versus granted via a role
    GENERIC_RESPONSE_ERROR_MESSAGE:
      required:
      - message
      properties:
        message:
          type: string
          example: Unexpected end of file [L9]
        code:
          type: string
          example: QEIVR2
    SUPERUSER:
      required:
      - superuser
      properties:
        superuser:
          type: boolean
    AUTO_CREATED:
      required:
      - auto_created
      properties:
        auto_created:
          type: boolean
    ROLENAME:
      required:
      - rolename
      properties:
        rolename:
          type: string
    USER_LIST:
      required:
      - users
      properties:
        users:
          type: array
          items:
            type: string
    USER:
      required:
      - enabled
      - superuser
      - roles
      - permissions
      properties:
        enabled:
          type: boolean
        superuser:
          type: boolean
        roles:
          type: array
          items:
            type: string
        permissions:
          type: array
          items:
            $ref: '#/components/schemas/PERMISSION_WITH_EXPLICIT'
    USER_CREATE:
      required:
      - username
      - password
      properties:
        username:
          type: string
        password:
          type: array
          description: Array of chars
          items:
            maxLength: 1
            minLength: 1
            type: string
    ENABLED:
      required:
      - enabled
      properties:
        enabled:
          type: boolean
    ROLE_LIST:
      required:
      - roles
      properties:
        roles:
          type: array
          items:
            type: string
  responses:
    MALFORMED_REQUEST_400:
      description: Malformed request body
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/GENERIC_RESPONSE_ERROR_MESSAGE'
    USER_LIST_DETAILED:
      description: List of Users in system, including their roles, permissions, and status
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/USER_LIST_DETAILED'
    USER_LIST:
      description: List of Users in system
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/USER_LIST'
    ROLE_LIST:
      description: List of Roles in system
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ROLE_LIST'
  parameters:
    role:
      name: role
      in: path
      description: Role name
      required: true
      schema:
        type: string
    user:
      name: user
      in: path
      description: Username
      required: true
      schema:
        type: string
  requestBodies:
    ROLENAME:
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ROLENAME'
externalDocs:
  url: https://docs.stardog.com
x-tagGroups:
- name: Data Unification
  tags:
  - Data Sources
  - Virtual Graphs
- name: Virtual Graphs External Compute
  tags:
  - Virtual Graphs External Compute
- name: Server
  tags:
  - Monitoring
  - Stored Functions
  - Server Status/Metrics
  - Server Admin
  - Queries
  - Cluster Admin
- name: Database
  tags:
  - Checkpoints
  - DB Admin
  - Integrity Constraints / SHACL
  - Data Caching
  - Graph Store Protocol
  - Matcher, aligning schemas from various data sources
  - Reasoning
  - Transactions
  - GraphQL
  - SPARQL
  - EntityResolution
- name: Security
  tags:
  - Roles
  - Permissions
  - Users
- name: Knowledge Catalog
  tags:
  - Knowledge Catalog