Amazon Q Q Users API
The Q Users API from Amazon Q — 2 operation(s) for q users.
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.
Call it yourself
curl for this page
This API
curl "https://apis.io/api/v1/apis/amazon-q:amazon-q-users-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.
A second provider on the same verified email joins the account you already have.
OpenAPI Specification
openapi: 3.2.0
info:
title: QBusiness Users API
version: '2023-11-27'
description: Generated from AWS's published Smithy model for QBusiness. 4 operation(s).
contact:
name: Amazon Web Services
url: https://aws.amazon.com/contact-us/
license:
name: Apache 2.0
identifier: Apache-2.0
url: https://github.com/aws/api-models-aws/blob/main/LICENSE
servers:
- url: https://qbusiness.{region}.amazonaws.com
variables:
region:
default: us-east-1
security:
- sigv4: []
tags:
- name: Users
paths:
/applications/{applicationId}/users:
post:
operationId: CreateUser
summary: Create User
description: Creates a universally unique identifier (UUID) mapped to a list of local user ids within an application.
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/CreateUserResponse'
'403':
description: AccessDeniedException
content:
application/json:
schema:
$ref: '#/components/schemas/AccessDeniedException'
'409':
description: ConflictException
content:
application/json:
schema:
$ref: '#/components/schemas/ConflictException'
'500':
description: InternalServerException
content:
application/json:
schema:
$ref: '#/components/schemas/InternalServerException'
'404':
description: ResourceNotFoundException
content:
application/json:
schema:
$ref: '#/components/schemas/ResourceNotFoundException'
'402':
description: ServiceQuotaExceededException
content:
application/json:
schema:
$ref: '#/components/schemas/ServiceQuotaExceededException'
'429':
description: ThrottlingException
content:
application/json:
schema:
$ref: '#/components/schemas/ThrottlingException'
'400':
description: ValidationException
content:
application/json:
schema:
$ref: '#/components/schemas/ValidationException'
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/CreateUserRequest'
tags:
- Users
/applications/{applicationId}/users/{userId}:
delete:
operationId: DeleteUser
summary: Delete User
description: Deletes a user by email id.
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/DeleteUserResponse'
'403':
description: AccessDeniedException
content:
application/json:
schema:
$ref: '#/components/schemas/AccessDeniedException'
'409':
description: ConflictException
content:
application/json:
schema:
$ref: '#/components/schemas/ConflictException'
'500':
description: InternalServerException
content:
application/json:
schema:
$ref: '#/components/schemas/InternalServerException'
'404':
description: ResourceNotFoundException
content:
application/json:
schema:
$ref: '#/components/schemas/ResourceNotFoundException'
'429':
description: ThrottlingException
content:
application/json:
schema:
$ref: '#/components/schemas/ThrottlingException'
'400':
description: ValidationException
content:
application/json:
schema:
$ref: '#/components/schemas/ValidationException'
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/DeleteUserRequest'
tags:
- Users
get:
operationId: GetUser
summary: Get User
description: Describes the universally unique identifier (UUID) associated with a local user in a data source.
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/GetUserResponse'
'403':
description: AccessDeniedException
content:
application/json:
schema:
$ref: '#/components/schemas/AccessDeniedException'
'409':
description: ConflictException
content:
application/json:
schema:
$ref: '#/components/schemas/ConflictException'
'500':
description: InternalServerException
content:
application/json:
schema:
$ref: '#/components/schemas/InternalServerException'
'404':
description: ResourceNotFoundException
content:
application/json:
schema:
$ref: '#/components/schemas/ResourceNotFoundException'
'429':
description: ThrottlingException
content:
application/json:
schema:
$ref: '#/components/schemas/ThrottlingException'
'400':
description: ValidationException
content:
application/json:
schema:
$ref: '#/components/schemas/ValidationException'
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/GetUserRequest'
tags:
- Users
put:
operationId: UpdateUser
summary: Update User
description: Updates a information associated with a user id.
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/UpdateUserResponse'
'403':
description: AccessDeniedException
content:
application/json:
schema:
$ref: '#/components/schemas/AccessDeniedException'
'409':
description: ConflictException
content:
application/json:
schema:
$ref: '#/components/schemas/ConflictException'
'500':
description: InternalServerException
content:
application/json:
schema:
$ref: '#/components/schemas/InternalServerException'
'404':
description: ResourceNotFoundException
content:
application/json:
schema:
$ref: '#/components/schemas/ResourceNotFoundException'
'402':
description: ServiceQuotaExceededException
content:
application/json:
schema:
$ref: '#/components/schemas/ServiceQuotaExceededException'
'429':
description: ThrottlingException
content:
application/json:
schema:
$ref: '#/components/schemas/ThrottlingException'
'400':
description: ValidationException
content:
application/json:
schema:
$ref: '#/components/schemas/ValidationException'
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/UpdateUserRequest'
tags:
- Users
components:
schemas:
GetUserResponse:
type: object
properties:
userAliases:
type: array
items:
$ref: '#/components/schemas/UserAlias'
description: A list of user aliases attached to a user.
DeleteUserRequest:
type: object
properties:
applicationId:
type: string
description: The identifier of the application from which the user is being deleted.
userId:
type: string
description: The user email being deleted.
required:
- applicationId
- userId
ValidationException:
type: object
properties:
message:
type: string
description: The message describing the ValidationException.
reason:
type: string
enum:
- CANNOT_PARSE
- FIELD_VALIDATION_FAILED
- UNKNOWN_OPERATION
description: The reason for the ValidationException.
fields:
type: array
items:
$ref: '#/components/schemas/ValidationExceptionField'
description: The input field(s) that failed validation.
required:
- message
- reason
ServiceQuotaExceededException:
type: object
properties:
message:
type: string
description: The message describing a ServiceQuotaExceededException.
resourceId:
type: string
description: The identifier of the resource affected.
resourceType:
type: string
description: The type of the resource affected.
required:
- message
- resourceId
- resourceType
UserAlias:
type: object
properties:
indexId:
type: string
description: The identifier of the index that the user aliases are associated with.
dataSourceId:
type: string
description: The identifier of the data source that the user aliases are associated with.
userId:
type: string
description: The identifier of the user id associated with the user aliases.
required:
- userId
GetUserRequest:
type: object
properties:
applicationId:
type: string
description: The identifier of the application connected to the user.
userId:
type: string
description: The user email address attached to the user.
required:
- applicationId
- userId
ResourceNotFoundException:
type: object
properties:
message:
type: string
description: The message describing a ResourceNotFoundException.
resourceId:
type: string
description: The identifier of the resource affected.
resourceType:
type: string
description: The type of the resource affected.
required:
- message
- resourceId
- resourceType
AccessDeniedException:
type: object
properties:
message:
type: string
required:
- message
InternalServerException:
type: object
properties:
message:
type: string
required:
- message
ThrottlingException:
type: object
properties:
message:
type: string
required:
- message
UpdateUserRequest:
type: object
properties:
applicationId:
type: string
description: The identifier of the application the user is attached to.
userId:
type: string
description: The email id attached to the user.
userAliasesToUpdate:
type: array
items:
$ref: '#/components/schemas/UserAlias'
description: The user aliases attached to the user id that are to be updated.
userAliasesToDelete:
type: array
items:
$ref: '#/components/schemas/UserAlias'
description: The user aliases attached to the user id that are to be deleted.
required:
- applicationId
- userId
ValidationExceptionField:
type: object
properties:
name:
type: string
description: The field name where the invalid entry was detected.
message:
type: string
description: A message about the validation exception.
required:
- name
- message
CreateUserResponse:
type: object
properties: {}
ConflictException:
type: object
properties:
message:
type: string
description: The message describing a ConflictException.
resourceId:
type: string
description: The identifier of the resource affected.
resourceType:
type: string
description: The type of the resource affected.
required:
- message
- resourceId
- resourceType
UpdateUserResponse:
type: object
properties:
userAliasesAdded:
type: array
items:
$ref: '#/components/schemas/UserAlias'
description: The user aliases that have been to be added to a user id.
userAliasesUpdated:
type: array
items:
$ref: '#/components/schemas/UserAlias'
description: The user aliases attached to a user id that have been updated.
userAliasesDeleted:
type: array
items:
$ref: '#/components/schemas/UserAlias'
description: The user aliases that have been deleted from a user id.
DeleteUserResponse:
type: object
properties: {}
CreateUserRequest:
type: object
properties:
applicationId:
type: string
description: The identifier of the application for which the user mapping will be created.
userId:
type: string
description: The user emails attached to a user mapping.
userAliases:
type: array
items:
$ref: '#/components/schemas/UserAlias'
description: The list of user aliases in the mapping.
clientToken:
type: string
description: A token that you provide to identify the request to create your Amazon Q Business user mapping.
required:
- applicationId
- userId
securitySchemes:
sigv4:
type: apiKey
in: header
name: Authorization
description: AWS Signature Version 4. The Authorization header carries an AWS4-HMAC-SHA256 signature over the canonical request, with X-Amz-Date (and X-Amz-Security-Token for temporary credentials). Not a bearer token.
x-aws-sigv4:
signingName: qbusiness
x-provenance:
method: harvested
publisher: Amazon Web Services
source: https://raw.githubusercontent.com/aws/api-models-aws/582e55931c45b944739742a2c1620b6026dd2d13/models/qbusiness/service/2023-11-27/qbusiness-2023-11-27.json
note: converted by smithy-to-openapi.py from AWS's Smithy model (roadmap#1001)