Operations 38
Documentation
APIReference
https://api.docs.moogsoft.com/docs/latest/branches/main/af91225840fe8-user-api
Documentation
https://docs.moogsoft.com/moogsoft-cloud/en/apis.html
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/user-management"
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.1.0
info:
version: 1.0.0
title: User API
description: API for User Service
termsOfService: 'https://www.moogsoft.com/legal-information/express-terms-conditions/'
contact:
name: API Support
url: 'https://docs.moogsoft.com/en/moogsoft-apis.html'
email: support@moogsoft.com
license:
url: 'https://www.moogsoft.com/legal-information'
name: Apex AIOps Incident Management Proprietary
servers:
- url: 'https://api.moogsoft.ai'
- url: 'https://api.dev.moogsoft.cloud'
paths:
/v1/groups:
get:
tags:
- Groups
summary: List User Groups
description: List all user groups currently defined in the system.
operationId: getGroups
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/MoogResponseListOfGroupDto'
'400':
description: Invalid parameters or data validation violation
content:
application/json:
schema:
$ref: '#/components/schemas/MoogFailureResponse'
'404':
description: Requested object(s) not found
content:
application/json:
schema:
$ref: '#/components/schemas/MoogFailureResponse'
4XX:
description: Authorization or other error
content:
application/json:
schema:
$ref: '#/components/schemas/MoogFailureResponse'
5XX:
description: Error
content:
application/json:
schema:
$ref: '#/components/schemas/MoogErrorResponse'
security:
- ApiKeyAuth: []
servers:
- url: 'https://api.moogsoft.ai'
- url: 'https://api.dev.moogsoft.cloud'
x-permissions:
value:
- 'group-management:no-access'
description: Required user permissions for this endpoint
post:
tags:
- Groups
summary: Create User Groups
description: Create new group(s) in the system
operationId: postGroups
requestBody:
required: true
content:
application/json:
schema:
type: array
description: The request body may be a single Group object or an array of Groups
minItems: 1
items:
type: object
examples:
User Groups:
description: Parameters used to build multiple valid user group
value:
- name: Support Team
description: Group for support team
groupMembers:
- 6217d0958391447445648af4
- 6217d0958391447445645dg7
roleAssignment: 6217d0958391498735648za2
- name: Backend Team
description: Group for backend team
groupMembers:
- 6217d0958391447445648ah6
- 6217d0958391447445645df6
roleAssignment: 6217d0958391498735648za3
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/IsgListResponseobject'
__errors__:
'#/components/schemas/IsgListResponseobject': No foreign doc with id components found
examples:
User Groups:
description: Response received after successfully creating multiple user groups
value:
status: success
data:
- name: Support Team
description: Group for support team
groupMembers:
- 6217d0958391447445648af4
- 6217d0958391447445645dg7
roleAssignment: 6217d0958391498735648za2
id: 6217d0958391447445648ab2
created: '2022-03-10T16:15:50Z'
createdBy: string
lastModified: '2022-03-10T16:15:50Z'
lastModifiedBy: string
isSso: true
- name: Backend Team
description: Group for backend team
groupMembers:
- 6217d0958391447445648ah6
- 6217d0958391447445645df6
roleAssignment: 6217d0958391498735648za3
id: 6217d0958391447445648ab2
created: '2022-03-10T16:15:50Z'
createdBy: string
lastModified: '2022-03-10T16:15:50Z'
lastModifiedBy: string
isSso: true
'400':
description: Bad Request
'404':
description: Requested object(s) not found
content:
application/json:
schema:
$ref: '#/components/schemas/IsgErrorResponse'
4XX:
description: Authorization or other error
content:
application/json:
schema:
$ref: '#/components/schemas/IsgErrorResponse'
5XX:
description: Error
content:
application/json:
schema:
$ref: '#/components/schemas/IsgErrorResponse'
security:
- ApiKeyAuth: []
servers:
- url: 'https://api.moogsoft.ai'
- url: 'https://api.dev.moogsoft.cloud'
x-permissions:
value:
- 'group-management:edit'
description: Required user permissions for this endpoint
'/v1/groups/{id}':
patch:
tags:
- Groups
summary: Update a User Group
description: Update an existing user group in the system
operationId: patchGroup
parameters:
- name: id
in: path
description: ID of the group
required: true
schema:
type: string
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
name:
type: string
description: The name of your user group
pattern: '^[a-zA-Z0-9.&()_\-\s]+$'
minLength: 1
maxLength: 127
examples:
- Support Team
description:
type: string
description: Description of your user group
examples:
- Group for Support Team
groupMembers:
type: array
description: List of the unique IDs for the members of the group
examples:
- - 6217d0958391447445648af4
- 6217d095839144744565dg7
items:
type: string
roleAssignment:
type: string
description: Unique ID of the role to be assigned to the group
examples:
- 6217d0958391498735648za2
required:
- name
- groupMembers
examples:
User Group:
description: Parameters of the user group to be updated
value:
name: Support Team
description: Group for support team
groupMembers:
- 6217d0958391447445648af4
- 6217d095839144744565dg7
roleAssignment: 6217d0958391498735648za2
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/MoogResponseGroupDto'
'400':
description: Invalid parameters or data validation violation
content:
application/json:
schema:
$ref: '#/components/schemas/MoogFailureResponse'
'404':
description: Requested object(s) not found
content:
application/json:
schema:
$ref: '#/components/schemas/MoogFailureResponse'
4XX:
description: Authorization or other error
content:
application/json:
schema:
$ref: '#/components/schemas/MoogFailureResponse'
5XX:
description: Error
content:
application/json:
schema:
$ref: '#/components/schemas/MoogErrorResponse'
security:
- ApiKeyAuth: []
servers:
- url: 'https://api.moogsoft.ai'
- url: 'https://api.dev.moogsoft.cloud'
x-permissions:
value:
- 'group-management:edit'
description: Required user permissions for this endpoint
get:
tags:
- Groups
summary: Get a User Group
description: Gets the specific user group that matches the provided ID
operationId: getGroup
parameters:
- name: id
in: path
description: ID of the group
required: true
schema:
type: string
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/MoogResponseGroupDto'
'400':
description: Invalid parameters or data validation violation
content:
application/json:
schema:
$ref: '#/components/schemas/MoogFailureResponse'
'404':
description: Requested object(s) not found
content:
application/json:
schema:
$ref: '#/components/schemas/MoogFailureResponse'
4XX:
description: Authorization or other error
content:
application/json:
schema:
$ref: '#/components/schemas/MoogFailureResponse'
5XX:
description: Error
content:
application/json:
schema:
$ref: '#/components/schemas/MoogErrorResponse'
security:
- ApiKeyAuth: []
servers:
- url: 'https://api.moogsoft.ai'
- url: 'https://api.dev.moogsoft.cloud'
x-permissions:
value:
- 'group-management:view'
description: Required user permissions for this endpoint
delete:
tags:
- Groups
summary: Delete a User Group
description: Delete a user group that already exists in the system
operationId: deleteGroup
parameters:
- name: id
in: path
description: ID of the group
required: true
schema:
type: string
responses:
'204':
description: No Content
'400':
description: Invalid parameters or data validation violation
content:
application/json:
schema:
$ref: '#/components/schemas/MoogFailureResponse'
'404':
description: Requested object(s) not found
content:
application/json:
schema:
$ref: '#/components/schemas/MoogFailureResponse'
4XX:
description: Authorization or other error
content:
application/json:
schema:
$ref: '#/components/schemas/MoogFailureResponse'
5XX:
description: Error
content:
application/json:
schema:
$ref: '#/components/schemas/MoogErrorResponse'
security:
- ApiKeyAuth: []
servers:
- url: 'https://api.moogsoft.ai'
- url: 'https://api.dev.moogsoft.cloud'
x-permissions:
value:
- 'group-management:edit'
description: Required user permissions for this endpoint
/v1/instance-type:
patch:
tags:
- InstanceType
summary: Sets the instance type
description: Sets the instance type
operationId: SetInstanceType
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/InstanceDto'
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/MoogResponseInstanceDto'
'400':
description: Invalid parameters or data validation violation
content:
application/json:
schema:
$ref: '#/components/schemas/MoogFailureResponse'
'404':
description: Requested object(s) not found
content:
application/json:
schema:
$ref: '#/components/schemas/MoogFailureResponse'
4XX:
description: Authorization or other error
content:
application/json:
schema:
$ref: '#/components/schemas/MoogFailureResponse'
5XX:
description: Error
content:
application/json:
schema:
$ref: '#/components/schemas/MoogErrorResponse'
security:
- ApiKeyAuth: []
servers:
- url: 'https://api.moogsoft.ai'
- url: 'https://api.dev.moogsoft.cloud'
x-permissions:
value:
- 'instance:edit'
description: Required user permissions for this endpoint
get:
tags:
- InstanceType
summary: Gets the instance type
description: Gets the instance type
operationId: GetInstanceType
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/MoogResponseInstanceDto'
'400':
description: Invalid parameters or data validation violation
content:
application/json:
schema:
$ref: '#/components/schemas/MoogFailureResponse'
'404':
description: Requested object(s) not found
content:
application/json:
schema:
$ref: '#/components/schemas/MoogFailureResponse'
4XX:
description: Authorization or other error
content:
application/json:
schema:
$ref: '#/components/schemas/MoogFailureResponse'
5XX:
description: Error
content:
application/json:
schema:
$ref: '#/components/schemas/MoogErrorResponse'
security:
- ApiKeyAuth: []
servers:
- url: 'https://api.moogsoft.ai'
- url: 'https://api.dev.moogsoft.cloud'
x-permissions:
value:
- 'instance:view'
description: Required user permissions for this endpoint
/v1/roles:
get:
tags:
- Roles
summary: Get all roles in the system
description: Get all roles currently defined in the system
operationId: getRoles
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/MoogResponseListOfRoleDto'
'400':
description: Invalid parameters or data validation violation
content:
application/json:
schema:
$ref: '#/components/schemas/MoogFailureResponse'
'404':
description: Requested object(s) not found
content:
application/json:
schema:
$ref: '#/components/schemas/MoogFailureResponse'
4XX:
description: Authorization or other error
content:
application/json:
schema:
$ref: '#/components/schemas/MoogFailureResponse'
5XX:
description: Error
content:
application/json:
schema:
$ref: '#/components/schemas/MoogErrorResponse'
security:
- ApiKeyAuth: []
servers:
- url: 'https://api.moogsoft.ai'
- url: 'https://api.dev.moogsoft.cloud'
x-permissions:
value:
- 'user:no-access'
description: Required user permissions for this endpoint
post:
tags:
- Roles
summary: Create a new roles in the system
description: Create a new role in the system
operationId: postRoles
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/BaseRoleDto'
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/MoogResponseRoleDto'
'400':
description: Bad Request
'404':
description: Requested object(s) not found
content:
application/json:
schema:
$ref: '#/components/schemas/MoogFailureResponse'
4XX:
description: Authorization or other error
content:
application/json:
schema:
$ref: '#/components/schemas/MoogFailureResponse'
5XX:
description: Error
content:
application/json:
schema:
$ref: '#/components/schemas/MoogErrorResponse'
security:
- ApiKeyAuth: []
servers:
- url: 'https://api.moogsoft.ai'
- url: 'https://api.dev.moogsoft.cloud'
x-permissions:
value:
- 'user:edit'
description: Required user permissions for this endpoint
'/v1/roles/{id}':
patch:
tags:
- Roles
summary: Update a role in the system
description: Update an existing role in the system
operationId: patchRoles
parameters:
- name: id
in: path
description: ID of the role
required: true
schema:
type: string
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/BaseRoleDto'
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/MoogResponseRoleDto'
'400':
description: Invalid parameters or data validation violation
content:
application/json:
schema:
$ref: '#/components/schemas/MoogFailureResponse'
'404':
description: Requested object(s) not found
content:
application/json:
schema:
$ref: '#/components/schemas/MoogFailureResponse'
4XX:
description: Authorization or other error
content:
application/json:
schema:
$ref: '#/components/schemas/MoogFailureResponse'
5XX:
description: Error
content:
application/json:
schema:
$ref: '#/components/schemas/MoogErrorResponse'
security:
- ApiKeyAuth: []
servers:
- url: 'https://api.moogsoft.ai'
- url: 'https://api.dev.moogsoft.cloud'
x-permissions:
value:
- 'user:edit'
description: Required user permissions for this endpoint
get:
tags:
- Roles
summary: Get specific role details
description: Get details for a specific role
operationId: getRole
parameters:
- name: id
in: path
description: ID of the role
required: true
schema:
type: string
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/MoogResponseRoleDto'
'400':
description: Invalid parameters or data validation violation
content:
application/json:
schema:
$ref: '#/components/schemas/MoogFailureResponse'
'404':
description: Requested object(s) not found
content:
application/json:
schema:
$ref: '#/components/schemas/MoogFailureResponse'
4XX:
description: Authorization or other error
content:
application/json:
schema:
$ref: '#/components/schemas/MoogFailureResponse'
5XX:
description: Error
content:
application/json:
schema:
$ref: '#/components/schemas/MoogErrorResponse'
security:
- ApiKeyAuth: []
servers:
- url: 'https://api.moogsoft.ai'
- url: 'https://api.dev.moogsoft.cloud'
x-permissions:
value:
- 'user:view'
description: Required user permissions for this endpoint
delete:
tags:
- Roles
summary: Delete a custom role in the system
description: Delete a role already in the system.
operationId: deleteRole
parameters:
- name: id
in: path
description: ID of the role
required: true
schema:
type: string
responses:
'204':
description: No Content
'400':
description: Invalid parameters or data validation violation
content:
application/json:
schema:
$ref: '#/components/schemas/MoogFailureResponse'
'404':
description: Requested object(s) not found
content:
application/json:
schema:
$ref: '#/components/schemas/MoogFailureResponse'
4XX:
description: Authorization or other error
content:
application/json:
schema:
$ref: '#/components/schemas/MoogFailureResponse'
5XX:
description: Error
content:
application/json:
schema:
$ref: '#/components/schemas/MoogErrorResponse'
security:
- ApiKeyAuth: []
servers:
- url: 'https://api.moogsoft.ai'
- url: 'https://api.dev.moogsoft.cloud'
x-permissions:
value:
- 'user:edit'
description: Required user permissions for this endpoint
/v1/sso/advanced-connection:
post:
tags:
- SSO
summary: Create a local connection for Auth0 multi tenancy
description: Creates a local connection to a master Auth0 connection in a multi tenancy system
operationId: CreateAdvancedSSOConn
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/SSOMultiTenancyConnDto'
responses:
'201':
description: Created
'400':
description: Bad Request
'404':
description: Requested object(s) not found
content:
application/json:
schema:
$ref: '#/components/schemas/MoogFailureResponse'
4XX:
description: Authorization or other error
content:
application/json:
schema:
$ref: '#/components/schemas/MoogFailureResponse'
5XX:
description: Error
content:
application/json:
schema:
$ref: '#/components/schemas/MoogErrorResponse'
security:
- ApiKeyAuth: []
servers:
- url: 'https://api.moogsoft.ai'
- url: 'https://api.dev.moogsoft.cloud'
x-permissions:
value:
- 'user:edit'
description: Required user permissions for this endpoint
/v1/sso/callback_url:
get:
tags:
- SSO
summary: Get a callback url for OIDC authentication
description: Get a callback url for OIDC based connection
operationId: getSSOCallBackUrl
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/IsgListResponseobject'
__errors__:
'#/components/schemas/IsgListResponseobject': No foreign doc with id components found
'400':
description: Invalid parameters or data validation violation
content:
application/json:
schema:
$ref: '#/components/schemas/MoogFailureResponse'
'404':
description: Requested object(s) not found
content:
application/json:
schema:
$ref: '#/components/schemas/MoogFailureResponse'
4XX:
description: Authorization or other error
content:
application/json:
schema:
$ref: '#/components/schemas/MoogFailureResponse'
5XX:
description: Error
content:
application/json:
schema:
$ref: '#/components/schemas/MoogErrorResponse'
security:
- ApiKeyAuth: []
servers:
- url: 'https://api.moogsoft.ai'
- url: 'https://api.dev.moogsoft.cloud'
x-permissions:
value:
- 'user:edit'
description: Required user permissions for this endpoint
/v1/sso/connection:
patch:
tags:
- SSO
summary: Edit SSO connection
description: Edit SSO connection
operationId: editSSOConnection
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
name:
type: string
maxLength: 60
options:
$ref: '#/components/schemas/SSOConnOptionsDto'
domains:
type: array
minItems: 1
items:
type: string
pattern: \S
useMapping:
type: boolean
useGroupMapping:
type: boolean
defaultRoleId:
type: string
mapping:
type: object
additionalProperties:
type: string
groupMapping:
type: object
additionalProperties:
type: string
isMultiTenant:
type: boolean
required:
- name
- options
- domains
examples:
SSO Connection:
description: Parameters use to create a valid OIDC sso connection
value:
name: connectionName
options:
clientId: yourClientID
clientSecret: yourClientSecret
discoveryUrl: your-discovery-url.com
claimsScope: ''
claimsFieldName: roles
groupClaimsFieldName: ''
strategy: oidc
domains:
- your-domain.com
mapping:
yourSSORole: yourMoogsoftRoleId
useMapping: true
groupMapping: {}
useGroupMapping: false
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/MoogResponseSSOReturnDto'
'400':
description: Invalid parameters or data validation violation
content:
application/json:
schema:
$ref: '#/components/schemas/MoogFailureResponse'
'404':
description: Requested object(s) not found
content:
application/json:
schema:
$ref: '#/components/schemas/MoogFailureResponse'
4XX:
description: Authorization or other error
content:
application/json:
schema:
$ref: '#/components/schemas/MoogFailureResponse'
5XX:
description: Error
content:
application/json:
schema:
$ref: '#/components/schemas/MoogErrorResponse'
security:
- ApiKeyAuth: []
servers:
- url: 'https://api.moogsoft.ai'
- url: 'https://api.dev.moogsoft.cloud'
x-permissions:
value:
- 'user:edit'
description: Required user permissions for this endpoint
get:
tags:
- SSO
summary: Get SSO connection details
description: Get SSO connection details
operationId: getSSOConnection
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/MoogResponseSSOConnMongoDto'
'400':
description: Invalid parameters or data validation violation
content:
application/json:
schema:
$ref: '#/components/schemas/MoogFailureResponse'
'404':
description: Requested object(s) not found
content:
application/json:
schema:
$ref: '#/components/schemas/MoogFailureResponse'
4XX:
description: Authorization or other error
content:
application/json:
schema:
$ref: '#/components/schemas/MoogFailureResponse'
5XX:
description: Error
content:
application/json:
schema:
$ref: '#/components/schemas/MoogErrorResponse'
security:
- ApiKeyAuth: []
servers:
- url: 'https://api.moogsoft.ai'
- url: 'https://api.dev.moogsoft.cloud'
x-permissions:
value:
- 'user:edit'
description: Required user permissions for this endpoint
post:
tags:
- SSO
summary: Create an auth0 connection
description: Create an auth0 connection
operationId: CreateAuth0Connection
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
name:
type: string
maxLength: 60
options:
$ref: '#/components/schemas/SSOConnOptionsDto'
domains:
type: array
minItems: 1
items:
type: string
pattern: \S
useMapping:
type: boolean
useGroupMapping:
type: boolean
defaultRoleId:
type: string
mapping:
type: object
additionalProperties:
type: string
groupMapping:
type: object
additionalProperties:
type: string
isMultiTenant:
type: boolean
required:
- name
- options
- domains
examples:
SSO Connection:
description: Parameters use to create a valid OIDC sso connection
value:
name: connectionName
options:
clientId: yourClientID
clientSecret: yourClientSecret
discoveryUrl: your-discovery-url.com
claimsScope: ''
claimsFieldName: roles
groupClaimsFieldName: ''
strategy: oidc
domains:
- yo
# --- truncated at 32 KB (92 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/moogsoft/refs/heads/main/openapi/moogsoft-user-management-openapi.yaml