Sonatype Nexus Security management: SAML users API

openapi: 3.0.1
info:
  contact:
    name: Sonatype Community Maintainers
    url: https://github.com/sonatype-nexus-community
  description: This documents the available APIs into [Sonatype Nexus Repository Manager](https://www.sonatype.com/products/sonatype-nexus-repository) as of version 3.91.0-07.
  license:
    name: Apache-2.0
    url: http://www.apache.org/licenses/LICENSE-2.0.html
  title: 'Sonatype Nexus Repository Manager assets Security management: SAML users API'
  version: 3.91.0-07
servers:
- url: /service/rest/
security:
- BasicAuth: []
tags:
- name: 'Security management: SAML users'
paths:
  /v1/security/saml/users:
    get:
      operationId: getUsers_1
      parameters:
      - description: An optional term to search userids for.
        in: query
        name: userId
        schema:
          type: string
      responses:
        '200':
          content: {}
          description: List of SAML users returned
        '403':
          content: {}
          description: Insufficient permissions
      summary: Retrieve a list of SAML users. The response is limited to 1,000 users.
      tags:
      - 'Security management: SAML users'
    post:
      operationId: createUser_1
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/SamlUserXO'
        description: The SAML user to create
        required: true
      responses:
        '201':
          content: {}
          description: SAML user created
        '400':
          content: {}
          description: Invalid user data or user already exists
        '403':
          content: {}
          description: Insufficient permissions
      summary: Create a new SAML user. This allows administrators to pre-create SAML users with roles before their first login.
      tags:
      - 'Security management: SAML users'
      x-codegen-request-body-name: body
  /v1/security/saml/users/{userId}:
    delete:
      operationId: deleteUser_1
      parameters:
      - description: The userid the request should apply to.
        in: path
        name: userId
        required: true
        schema:
          type: string
      responses:
        '204':
          content: {}
          description: SAML user deleted
        '403':
          content: {}
          description: Insufficient permissions
        '404':
          content: {}
          description: User not found
      summary: Delete a SAML user.
      tags:
      - 'Security management: SAML users'
    get:
      operationId: getUser
      parameters:
      - description: The userid the request should apply to.
        in: path
        name: userId
        required: true
        schema:
          type: string
      responses:
        '200':
          content: {}
          description: SAML user returned
        '403':
          content: {}
          description: Insufficient permissions
        '404':
          content: {}
          description: User not found
      summary: Retrieve a SAML user by userId.
      tags:
      - 'Security management: SAML users'
    put:
      operationId: updateUser_1
      parameters:
      - description: The userid the request should apply to.
        in: path
        name: userId
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/SamlUserXO'
        description: The SAML user to update
        required: true
      responses:
        '204':
          content: {}
          description: SAML user updated
        '400':
          content: {}
          description: Invalid user data
        '403':
          content: {}
          description: Insufficient permissions
        '404':
          content: {}
          description: User not found
      summary: Update a SAML user's roles and attributes.
      tags:
      - 'Security management: SAML users'
      x-codegen-request-body-name: body
components:
  schemas:
    SamlUserXO:
      properties:
        emailAddress:
          description: The email address of the SAML user
          type: string
        firstName:
          description: The first name of the SAML user
          type: string
        lastName:
          description: The last name of the SAML user
          type: string
        roles:
          description: The roles assigned to the SAML user
          items:
            type: string
          type: array
          uniqueItems: true
        status:
          description: The status of the SAML user (active, disabled)
          type: string
        userId:
          description: The userid for the SAML user
          type: string
      required:
      - status
      - userId
      type: object
  securitySchemes:
    BasicAuth:
      scheme: basic
      type: http
x-original-swagger-version: '2.0'