StackRox UserService API

openapi: 3.0.0
info:
  title: API Reference AlertService UserService API
  version: '1'
  description: API reference for the StackRox Kubernetes Security Platform (upstream of Red Hat Advanced Cluster Security). Provides risk analysis, visibility, runtime alerts, policy management, compliance checking, and vulnerability management for containerized workloads. Authentication uses API tokens generated via /v1/apitokens/generate and passed as Bearer tokens.
  contact:
    email: support@stackrox.com
    url: https://www.stackrox.io/
  license:
    name: All Rights Reserved
    url: https://www.stackrox.com/
servers:
- url: https://{central-host}
  description: StackRox Central API server
  variables:
    central-host:
      default: stackrox.localhost
      description: StackRox Central hostname or IP
security:
- ApiToken: []
tags:
- name: UserService
paths:
  /v1/users:
    get:
      operationId: GetUsers
      responses:
        '200':
          description: A successful response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/v1GetUsersResponse'
      tags:
      - UserService
  /v1/users/{id}:
    get:
      operationId: GetUser
      responses:
        '200':
          description: A successful response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/storageUser'
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: string
      tags:
      - UserService
  /v1/usersattributes:
    get:
      operationId: GetUsersAttributes
      responses:
        '200':
          description: A successful response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/v1GetUsersAttributesResponse'
      tags:
      - UserService
components:
  schemas:
    storageUserAttribute:
      type: object
      properties:
        key:
          type: string
        value:
          type: string
    v1GetUsersResponse:
      type: object
      properties:
        users:
          type: array
          items:
            $ref: '#/components/schemas/storageUser'
      title: 'Next Tag: 2'
    storageUser:
      type: object
      properties:
        id:
          type: string
        authProviderId:
          type: string
        attributes:
          type: array
          items:
            $ref: '#/components/schemas/storageUserAttribute'
      description: User is an object that allows us to track the roles a user is tied to, and how they logged in.
    v1UserAttributeTuple:
      type: object
      properties:
        authProviderId:
          type: string
        key:
          type: string
        value:
          type: string
      title: 'UserAttributeTuple descript the auth:key:value tuple that decides group membership.

        Next Tag: 4'
    v1GetUsersAttributesResponse:
      type: object
      properties:
        usersAttributes:
          type: array
          items:
            $ref: '#/components/schemas/v1UserAttributeTuple'
      title: 'Next Tag: 2'
  securitySchemes:
    ApiToken:
      type: apiKey
      in: header
      name: Authorization
      description: 'StackRox API token. Format: Bearer {token}'