User management API. To manage users, you must have the administrator role or your role must have been assigned the manage users and roles capability. For more information, see Manage Users.
Every API here is available over the APIs.io API and to AI agents over MCP.
One button, every client — Claude, Cursor, VS Code and the rest.
https://apis.io/mcp
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.curl "https://apis.io/api/v1/apis/sumo-logic-user-management-api"curl "https://apis.io/api/v1/apis?limit=25"Discovery needs no key. Ratings and market analysis are Pro.
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: 3.2.0
info:
title: Sumo Logic User Management API
description: '# Getting Started
Welcome to the Sumo Logic API reference.'
version: 1.0.0
x-logo:
url: ./sumologic_logo.png
servers:
- url: https://api.au.sumologic.com/api/
description: AU deployment API server
- url: https://api.ca.sumologic.com/api/
description: CA deployment API server
- url: https://api.de.sumologic.com/api/
description: DE deployment API server
- url: https://api.eu.sumologic.com/api/
description: EU deployment API server
- url: https://api.fed.sumologic.com/api/
description: FED deployment API server
- url: https://api.jp.sumologic.com/api/
description: JP deployment API server
- url: https://api.kr.sumologic.com/api/
description: KR deployment API server
- url: https://api.in.sumologic.com/api/
description: IN deployment API server
- url: https://api.sumologic.com/api/
description: US1 deployment API server
- url: https://api.us2.sumologic.com/api/
description: US2 deployment API server
security:
- basicAuth: []
tags:
- name: User Management
description: 'User management API.
To manage users, you must have the administrator role or your role must have been assigned the manage users and roles capability. For more information, see Manage Users.'
x-displayName: Users
paths:
/v1/users:
get:
tags:
- User Management
summary: Get A List Of Users
description: Get a list of all users in the organization. The response is paginated with a default limit of 100 users per page.
operationId: listUsers
parameters:
- name: limit
in: query
description: Limit the number of users returned in the response. The number of users returned may be less than the `limit`.
required: false
schema:
maximum: 1000
minimum: 1
type: integer
format: int32
default: 100
- name: token
in: query
description: Continuation token to get the next page of results. A page object with the next continuation token is returned in the response body. Subsequent GET requests should specify the continuation token to get the next page of results. `token` is set to null when no more pages are left.
required: false
schema:
type: string
- name: sortBy
in: query
description: Sort the list of users by the `firstName`, `lastName`, or `email` field.
required: false
schema:
type: string
- name: email
in: query
description: Find user with the given email address.
required: false
schema:
minLength: 1
type: string
- name: includeServiceAccounts
in: query
description: Include service accounts while listing users within the organization.
required: false
schema:
type: boolean
responses:
'200':
description: A paginated list of users in the organization.
content:
application/json:
schema:
$ref: '#/components/schemas/ListUserModelsResponse'
default:
description: Operation failed with an error.
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
post:
tags:
- User Management
summary: Create A New User
description: Create a new user in the organization.
operationId: createUser
parameters: []
requestBody:
description: Information about the new user.
content:
application/json:
schema:
$ref: '#/components/schemas/CreateUserDefinition'
required: true
responses:
'200':
description: The user has been created.
content:
application/json:
schema:
$ref: '#/components/schemas/UserModel'
default:
description: Operation failed with an error.
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
/v1/users/{id}:
get:
tags:
- User Management
summary: Get A User
description: Get a user with the given identifier from the organization.
operationId: getUser
parameters:
- name: id
in: path
description: Identifier of user to return.
required: true
schema:
type: string
responses:
'200':
description: User object that was requested.
content:
application/json:
schema:
$ref: '#/components/schemas/UserModel'
default:
description: Operation failed with an error.
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
put:
tags:
- User Management
summary: Update A User
description: Update an existing user in the organization.
operationId: updateUser
parameters:
- name: id
in: path
description: Identifier of the user to update.
required: true
schema:
type: string
requestBody:
description: Information to update about the user.
content:
application/json:
schema:
$ref: '#/components/schemas/UpdateUserDefinition'
required: true
responses:
'200':
description: The user was successfully modified.
content:
application/json:
schema:
$ref: '#/components/schemas/UserModel'
default:
description: Operation failed with an error.
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
delete:
tags:
- User Management
summary: Delete A User
description: Delete a user with the given identifier from the organization and transfer their content to the user with the identifier specified in "transferTo".
operationId: deleteUser
parameters:
- name: id
in: path
description: Identifier of the user to delete.
required: true
schema:
type: string
- name: transferTo
in: query
description: Identifier of the user to receive the transfer of content from the deleted user. <br> **Note:** If `deleteContent` is not set to `true`, and no user identifier is specified in `transferTo`, content from the deleted user is transferred to the executing user.
required: false
schema:
type: string
- name: deleteContent
in: query
description: Whether to delete content from the deleted user or not. <br> **Warning:** If `deleteContent` is set to `true`, all of the content for the user being deleted is permanently deleted and cannot be recovered.
required: false
schema:
type: boolean
responses:
'204':
description: User was deleted successfully.
default:
description: Operation failed with an error.
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
/v1/users/{id}/email/requestChange:
post:
tags:
- User Management
summary: Change Email Address
description: An email with an activation link is sent to the user’s new email address. The user must click the link in the email within seven days to complete the email address change, or the link will expire.
operationId: requestChangeEmail
parameters:
- name: id
in: path
description: Identifier of the user to change email address.
required: true
schema:
type: string
requestBody:
description: New email address of the user.
content:
application/json:
schema:
$ref: '#/components/schemas/ChangeEmailRequest'
required: true
responses:
'204':
description: Email change request was submitted successfully.
default:
description: Operation failed with an error.
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
/v1/users/{id}/password/reset:
post:
tags:
- User Management
summary: Reset Password
description: Reset a user's password.
operationId: resetPassword
parameters:
- name: id
in: path
description: Identifier of the user to reset password.
required: true
schema:
type: string
responses:
'204':
description: User's password was reset successfully.
default:
description: Operation failed with an error.
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
/v1/users/{id}/unlock:
post:
tags:
- User Management
summary: Unlock A User
description: Unlock another user's account.
operationId: unlockUser
parameters:
- name: id
in: path
description: The id of the user that needs to be unlocked.
required: true
schema:
type: string
responses:
'204':
description: User's account was unlocked successfully.
default:
description: Operation failed with an error.
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
/v1/users/{id}/mfa/disable:
put:
tags:
- User Management
summary: Disable MFA For User
description: Disable multi-factor authentication for given user.
operationId: disableMfa
parameters:
- name: id
in: path
description: Identifier of the user to disable MFA for.
required: true
schema:
type: string
requestBody:
description: Email and Password of the user to disable MFA for.
content:
application/json:
schema:
$ref: '#/components/schemas/DisableMfaRequest'
required: true
responses:
'204':
description: User's MFA was disabled successfully.
default:
description: Operation failed with an error.
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
/v1/users/{id}/resendWelcomeEmail:
post:
tags:
- User Management
summary: Resend Verification Email
description: Resend the welcome email to a user.
operationId: resendWelcomeEmail
parameters:
- name: id
in: path
description: Identifier of the user to resend the welcome email.
required: true
schema:
type: string
responses:
'204':
description: Welcome email was resent successfully.
default:
description: Operation failed with an error.
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
components:
schemas:
MetadataModel:
required:
- createdAt
- createdBy
- modifiedAt
- modifiedBy
type: object
properties:
createdAt:
type: string
description: Creation timestamp in UTC in [RFC3339](https://tools.ietf.org/html/rfc3339) format.
format: date-time
example: 2018-10-16 09:10:00+00:00
createdBy:
type: string
description: Identifier of the user who created the resource.
example: 0000000006743FDD
modifiedAt:
type: string
description: Last modification timestamp in UTC.
format: date-time
example: 2018-10-16 09:10:00+00:00
modifiedBy:
type: string
description: Identifier of the user who last modified the resource.
example: 0000000006743FE8
ListUserModelsResponse:
required:
- data
type: object
properties:
data:
type: array
description: List of users.
items:
$ref: '#/components/schemas/UserModel'
next:
type: string
description: Next continuation token.
example: GDCiRv4vebF3UWFJQ1kySXBOR3Bzh69GR0RyWm9vCtc
CreateUserDefinition:
required:
- email
- firstName
- lastName
- roleIds
type: object
properties:
firstName:
maxLength: 128
minLength: 1
type: string
description: First name of the user.
example: John
lastName:
maxLength: 128
minLength: 0
type: string
description: Last name of the user.
example: Doe
email:
maxLength: 255
type: string
description: Email address of the user.
format: email
example: johndoe@acme.com
roleIds:
type: array
description: List of roleIds associated with the user.
example:
- 00000000000001DF
- 00000000000002D2
items:
type: string
ErrorResponse:
required:
- errors
- id
type: object
properties:
id:
type: string
description: An identifier for the error; this is unique to the specific API request.
example: IUUQI-DGH5I-TJ045
errors:
type: array
description: A list of one or more causes of the error.
example:
- code: auth:password_too_short
message: Your password was too short.
- code: auth:password_character_classes
message: Your password did not contain any non-alphanumeric characters
items:
$ref: '#/components/schemas/ErrorDescription'
ErrorDescription:
required:
- code
- message
type: object
properties:
code:
type: string
description: An error code describing the type of error.
example: auth:password_too_short
message:
type: string
description: A short English-language description of the error.
example: Your password was too short.
detail:
type: string
description: An optional fuller English-language description of the error.
example: Your password was 5 characters long, the minimum length is 12 characters. See http://example.com/password for more information.
meta:
type: object
description: An optional list of metadata about the error.
example:
minLength: 12
actualLength: 5
DisableMfaRequest:
required:
- email
- password
type: object
properties:
email:
maxLength: 255
type: string
description: Email of user whose mfa is being disabled.
format: email
example: johndoe@cme.com
password:
type: string
description: Password of user whose mfa is being disabled.
ChangeEmailRequest:
required:
- email
type: object
properties:
email:
maxLength: 255
type: string
description: New email address of the user.
format: email
example: johndoe@acme.com
UpdateUserDefinition:
required:
- firstName
- lastName
type: object
properties:
firstName:
maxLength: 128
minLength: 1
type: string
description: First name of the user. If the caller has `manageUsersAndRoles` capability, this field can be updated for any user. If the caller does NOT have `manageUsersAndRoles` capability, then only the calling user's firstName can be updated.
example: John
lastName:
maxLength: 128
minLength: 0
type: string
description: Last name of the user. If the caller has `manageUsersAndRoles` capability, this field can be updated for any user. If the caller does NOT have `manageUsersAndRoles` capability, then only the calling user's lastName can be updated.
example: Doe
isActive:
type: boolean
description: This has the value `true` if the user is active and `false` if they have been deactivated. To modify this field you must have the `manageUserAndRoles` capability.
example: true
roleIds:
type: array
description: List of role identifiers associated with the user. To modify this field you must have the `manageUserAndRoles` capability.
example:
- 00000000000001DF
- 00000000000002D2
items:
type: string
UserModel:
type: object
allOf:
- $ref: '#/components/schemas/CreateUserDefinition'
- $ref: '#/components/schemas/MetadataModel'
- required:
- id
properties:
id:
type: string
description: Unique identifier for the user.
example: 000000000FE20FE2
isActive:
type: boolean
description: True if the user is active.
example: true
isLocked:
type: boolean
description: This has the value `true` if the user's account has been locked. If a user tries to log into their account several times and fails, his or her account will be locked for security reasons.
example: false
isMfaEnabled:
type: boolean
description: True if multi factor authentication is enabled for the user.
example: false
lastLoginTimestamp:
type: string
description: Timestamp of the last login for the user in UTC. Will be null if the user has never logged in.
format: date-time
securitySchemes:
basicAuth:
type: http
scheme: basic
x-tagGroups:
- name: Archive Management
tags:
- archiveManagement
- name: Health Events
tags:
- healthEvents
- name: Infrequent Data Tier
tags:
- logSearchesEstimatedUsage
- name: Ingest Budgets Management V2
tags:
- ingestBudgetManagementV2
- name: Library Management
tags:
- appManagement
- appManagementV2
- contentManagement
- dashboardManagement
- folderManagement
- lookupManagement
- contentPermissions
- logSearchesManagement
- parsersLibraryManagement
- name: Metrics
tags:
- metricsSearchesManagement
- transformationRuleManagement
- metricsQuery
- metricsSearchesManagementV2
- name: Security Management
tags:
- accessKeyManagement
- oauthManagement
- accountManagement
- passwordPolicy
- policiesManagement
- samlConfigurationManagement
- serviceAllowlistManagement
- serviceAccountManagement
- scimUserManagement
- name: Organizations Management
tags:
- orgsManagement
- name: Settings Management
tags:
- connectionManagement
- dynamicParsingRuleManagement
- extractionRuleManagement
- fieldManagementV1
- partitionManagement
- scheduledViewManagement
- logsDataForwardingManagement
- dataDeletionRules
- name: Tokens Management
tags:
- tokensLibraryManagement
- name: Tracing
tags:
- traces
- spanAnalytics
- serviceMap
- name: Users and Roles Management
tags:
- roleManagement
- roleManagementV2
- userManagement
- name: Threat Intel Ingest Management
tags:
- threatIntelIngest
- threatIntelIngestProducer
- name: OpenTelemetry Collector Management
tags:
- otCollectorManagementExternal
- name: Source Template Management
tags:
- sourceTemplateManagementExternal
- name: Schema Base Management
tags:
- schemaBaseManagement
- name: Event Analytics Management
tags:
- eventAnalytics
- name: Budget Management
tags:
- budgetManagement
- name: Macro Management
tags:
- macroManagement
- name: Muting Schedules Management
tags:
- mutingSchedulesLibraryManagement
- name: SLO Management
tags:
- slosLibraryManagement
- name: Monitor Management
tags:
- monitorsLibraryManagement