Solvimon users API
The users API from Solvimon — 8 operation(s) for users.
OpenAPI Specification
openapi: 3.1.0
info:
title: Configuration alertRules users API
version: 1.0.0
servers:
- url: https://test.api.solvimon.com
description: The TEST environment for our API
- url: https://api.solvimon.com
description: The live environment for our API
tags:
- name: users
paths:
/v{version}/users:
get:
operationId: getUsers
summary: Get a list of all users
description: Requires the USER.MORTAL.VIEW permission.
tags:
- users
parameters:
- name: version
in: path
description: version
required: true
schema:
type: string
default: '1'
- name: active
in: query
description: The active flag by which the resource will be filtered.
required: false
schema:
type: boolean
- name: username
in: query
description: Filter based on username
required: false
schema:
type: string
- name: limit
in: query
description: The amount of records shown in the list
required: false
schema:
type: integer
- name: page
in: query
description: The page which is going to be shown
required: false
schema:
type: integer
- name: order_by
in: query
description: The parameter by which the response is ordered.
required: false
schema:
type: string
- name: order_direction
in: query
description: The order direction by which the response is ordered.
required: false
schema:
type: string
- name: X-API-KEY
in: header
required: true
schema:
type: string
- name: x-platform-id
in: header
description: Platform ID.
required: false
schema:
type: string
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/UserPaginatedResponseWrapper'
'401':
description: Unauthorized
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
'403':
description: Forbidden
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
'500':
description: Internal Server Error
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
post:
operationId: postUsers
summary: Create a user
description: Requires the USER.MORTAL.CREATE permission.
tags:
- users
parameters:
- name: version
in: path
description: version
required: true
schema:
type: string
default: '1'
- name: X-API-KEY
in: header
required: true
schema:
type: string
- name: x-platform-id
in: header
description: Platform ID.
required: false
schema:
type: string
responses:
'201':
description: Created
content:
application/json:
schema:
$ref: '#/components/schemas/User'
'400':
description: Bad Request
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
'401':
description: Unauthorized
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
'403':
description: Forbidden
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
'500':
description: Internal Server Error
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/UserCreateRequest'
/v{version}/users/{resourceId}:
get:
operationId: getUsersByResourceId
summary: Get a user by id
description: Requires the USER.MORTAL.VIEW permission.
tags:
- users
parameters:
- name: version
in: path
description: version
required: true
schema:
type: string
default: '1'
- name: resourceId
in: path
description: The ID of the resource to be requested.
required: true
schema:
type: string
default: ''
- name: X-API-KEY
in: header
required: true
schema:
type: string
- name: x-platform-id
in: header
description: Platform ID.
required: false
schema:
type: string
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/User'
'401':
description: Unauthorized
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
'403':
description: Forbidden
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
'500':
description: Internal Server Error
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
patch:
operationId: patchUsersByResourceId
summary: Patch a user password or username
description: Requires the USER.MORTAL.UPDATE permission.
tags:
- users
parameters:
- name: version
in: path
description: version
required: true
schema:
type: string
default: '1'
- name: resourceId
in: path
description: The ID of the resource to be requested.
required: true
schema:
type: string
default: ''
- name: X-API-KEY
in: header
required: true
schema:
type: string
- name: x-platform-id
in: header
description: Platform ID.
required: false
schema:
type: string
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/User'
'400':
description: Bad Request
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
'401':
description: Unauthorized
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
'403':
description: Forbidden
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
'500':
description: Internal Server Error
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/UserUpdateRequest'
/v{version}/users/{resourceId}/memberships:
get:
operationId: getUsersByResourceIdMemberships
summary: Get all account memberships for a user
description: Requires the USER.MORTAL.VIEW permission.
tags:
- users
parameters:
- name: version
in: path
description: version
required: true
schema:
type: string
default: '1'
- name: resourceId
in: path
description: The ID of the resource to be requested.
required: true
schema:
type: string
default: ''
- name: X-API-KEY
in: header
required: true
schema:
type: string
- name: x-platform-id
in: header
description: Platform ID.
required: false
schema:
type: string
responses:
'200':
description: OK
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/AccountMembershipRepresentation'
'401':
description: Unauthorized
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
'403':
description: Forbidden
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
'500':
description: Internal Server Error
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
post:
operationId: postUsersByResourceIdMemberships
summary: Add an account membership for a user
description: Requires the USER.MORTAL.UPDATE permission.
tags:
- users
parameters:
- name: version
in: path
description: version
required: true
schema:
type: string
default: '1'
- name: resourceId
in: path
description: The ID of the resource for which the action is posted.
required: true
schema:
type: string
default: ''
- name: X-API-KEY
in: header
required: true
schema:
type: string
- name: x-platform-id
in: header
description: Platform ID.
required: false
schema:
type: string
responses:
'201':
description: Created
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/AccountMembershipRepresentation'
'400':
description: Bad Request
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
'401':
description: Unauthorized
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
'403':
description: Forbidden
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
'500':
description: Internal Server Error
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/AccountMembershipRepresentationCreateRequest'
/v{version}/users/{resourceId}/memberships/{membershipResourceId}:
patch:
operationId: patchUsersByResourceIdMembershipsByMembershipResourceId
summary: Patch an account membership
description: Requires the USER.MORTAL.UPDATE permission.
tags:
- users
parameters:
- name: version
in: path
description: version
required: true
schema:
type: string
default: '1'
- name: membershipResourceId
in: path
description: The ID of the membership to be patched.
required: true
schema:
type: string
default: ''
- name: resourceId
in: path
description: The ID of the user to be patched.
required: true
schema:
type: string
default: ''
- name: X-API-KEY
in: header
required: true
schema:
type: string
- name: x-platform-id
in: header
description: Platform ID.
required: false
schema:
type: string
responses:
'200':
description: OK
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/AccountMembershipRepresentation'
'400':
description: Bad Request
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
'401':
description: Unauthorized
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
'403':
description: Forbidden
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
'500':
description: Internal Server Error
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/AccountMembershipRepresentationUpdateRequest'
/v{version}/users/{resourceId}/teams:
get:
operationId: getUsersByResourceIdTeams
summary: Get all the team memberships of a user
description: Requires the USER.MORTAL.VIEW permission.
tags:
- users
parameters:
- name: version
in: path
description: version
required: true
schema:
type: string
default: '1'
- name: resourceId
in: path
description: The ID of the resource to be requested.
required: true
schema:
type: string
default: ''
- name: X-API-KEY
in: header
required: true
schema:
type: string
- name: x-platform-id
in: header
description: Platform ID.
required: false
schema:
type: string
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/TeamMemberPaginatedResponseWrapper'
'401':
description: Unauthorized
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
'403':
description: Forbidden
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
'500':
description: Internal Server Error
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
post:
operationId: postUsersByResourceIdTeams
summary: Give a user membership to a team, granting access to all the accounts the team has access to
description: Requires the USER.MORTAL.UPDATE permission.
tags:
- users
parameters:
- name: version
in: path
description: version
required: true
schema:
type: string
default: '1'
- name: resourceId
in: path
description: The ID of the resource for which the action is posted.
required: true
schema:
type: string
default: ''
- name: X-API-KEY
in: header
required: true
schema:
type: string
- name: x-platform-id
in: header
description: Platform ID.
required: false
schema:
type: string
responses:
'201':
description: Created
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/TeamMemberRepresentation'
'400':
description: Bad Request
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
'401':
description: Unauthorized
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
'403':
description: Forbidden
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
'500':
description: Internal Server Error
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/TeamMemberRepresentationCreateRequest'
/v{version}/users/search:
get:
operationId: getUsersSearch
summary: Search for a user, using provided filters
description: Requires the USER.MORTAL.VIEW permission.
tags:
- users
parameters:
- name: version
in: path
description: version
required: true
schema:
type: string
default: '1'
- name: username
in: query
description: Filter based on username
required: false
schema:
type: string
- name: user_type
in: query
description: Filter based on user type
required: false
schema:
type: string
- name: X-API-KEY
in: header
required: true
schema:
type: string
- name: x-platform-id
in: header
description: Platform ID.
required: false
schema:
type: string
- name: resource_id
in: header
description: Resource Id of the user.
required: false
schema:
type: string
responses:
'200':
description: OK
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/User'
'401':
description: Unauthorized
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
'403':
description: Forbidden
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
'500':
description: Internal Server Error
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
/v{version}/users/revoke-invite:
post:
operationId: postUsersRevokeInvite
summary: Revoke a user invite by username
description: Requires the USER.MORTAL.UPDATE permission.
tags:
- users
parameters:
- name: version
in: path
description: version
required: true
schema:
type: string
default: '1'
- name: X-API-KEY
in: header
required: true
schema:
type: string
- name: x-platform-id
in: header
description: Platform ID.
required: false
schema:
type: string
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/User'
'401':
description: Unauthorized
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
'403':
description: Forbidden
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
'500':
description: Internal Server Error
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/UserCreateRequest'
/v{version}/users/invite:
post:
operationId: postUsersInvite
summary: Invite a user
description: Requires the USER.MORTAL.CREATE permission.
tags:
- users
parameters:
- name: version
in: path
description: version
required: true
schema:
type: string
default: '1'
- name: X-API-KEY
in: header
required: true
schema:
type: string
- name: x-platform-id
in: header
description: Platform ID.
required: false
schema:
type: string
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/UserInvite'
'401':
description: Unauthorized
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
'403':
description: Forbidden
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/UserInviteCreateRequest'
components:
schemas:
UserStatus:
type: string
enum:
- INVITED
- INVITE_REVOKED
- ACTIVE
- INACTIVE
description: Indicates whether the user is active
title: UserStatus
UserCreateRequestStatus:
type: string
enum:
- INVITED
- INVITE_REVOKED
- ACTIVE
- INACTIVE
description: Indicates whether the user is active
title: UserCreateRequestStatus
AccountMembershipRepresentationUpdateRequestType:
type: string
enum:
- ADMIN
- USER
- PARTNER
description: The type of this membership
title: AccountMembershipRepresentationUpdateRequestType
UserUpdateRequest:
type: object
properties:
object_type:
type:
- string
- 'null'
id:
type:
- string
- 'null'
description: The id of the user
entity_id:
type:
- string
- 'null'
description: The entity id of the entity that this user belongs to
created_at:
type:
- string
- 'null'
description: The date when this user was created
active:
type:
- boolean
- 'null'
description: Indicates whether the user is active
status:
oneOf:
- $ref: '#/components/schemas/UserUpdateRequestStatus'
- type: 'null'
description: Indicates whether the user is active
account_memberships:
type:
- array
- 'null'
items:
$ref: '#/components/schemas/AccountMembershipRepresentationUpdateRequest'
description: The account memberships that this user has
team_memberships:
type:
- array
- 'null'
items:
$ref: '#/components/schemas/TeamMemberRepresentationUpdateRequest'
description: The team memberships that this user has
username:
type: string
description: The email of the user
password:
type:
- string
- 'null'
description: The password of the user. Should have a minimum of 8 characters, of which one is a number and one is a capital letter
invite_expired:
type:
- boolean
- 'null'
description: Indicates whether the invite sent to the user is expired
title: UserUpdateRequest
RoleChildRolesItems:
type: object
properties: {}
title: RoleChildRolesItems
UserPaginatedResponseWrapper:
type: object
properties:
data:
type: array
items:
$ref: '#/components/schemas/User'
limit:
type:
- integer
- 'null'
page:
type:
- integer
- 'null'
total_number_of_pages:
type:
- integer
- 'null'
links:
$ref: '#/components/schemas/PaginationLinks'
required:
- data
- links
title: UserPaginatedResponseWrapper
UserCreateRequest:
type: object
properties:
object_type:
type:
- string
- 'null'
id:
type:
- string
- 'null'
description: The id of the user
entity_id:
type:
- string
- 'null'
description: The entity id of the entity that this user belongs to
created_at:
type:
- string
- 'null'
description: The date when this user was created
active:
type:
- boolean
- 'null'
description: Indicates whether the user is active
status:
oneOf:
- $ref: '#/components/schemas/UserCreateRequestStatus'
- type: 'null'
description: Indicates whether the user is active
account_memberships:
type:
- array
- 'null'
items:
$ref: '#/components/schemas/AccountMembershipRepresentationCreateRequest'
description: The account memberships that this user has
team_memberships:
type:
- array
- 'null'
items:
$ref: '#/components/schemas/TeamMemberRepresentationCreateRequest'
description: The team memberships that this user has
username:
type: string
description: The email of the user
password:
type:
- string
- 'null'
description: The password of the user. Should have a minimum of 8 characters, of which one is a number and one is a capital letter
invite_expired:
type:
- boolean
- 'null'
description: Indicates whether the invite sent to the user is expired
title: UserCreateRequest
UserUpdateRequestStatus:
type: string
enum:
- INVITED
- INVITE_REVOKED
- ACTIVE
- INACTIVE
description: Indicates whether the user is active
title: UserUpdateRequestStatus
ApiErrorType:
type: string
enum:
- API_ERROR
- INVALID_REQUEST
title: ApiErrorType
ApiError:
type: object
properties:
type:
$ref: '#/components/schemas/ApiErrorType'
code:
$ref: '#/components/schemas/ApiErrorCode'
field:
type:
- string
- 'null'
message:
type: string
resource_id:
type:
- string
- 'null'
resource_type:
oneOf:
- $ref: '#/components/schemas/ApiErrorResourceType'
- type: 'null'
required:
- type
- code
- message
title: ApiError
UserInvite:
type: object
properties:
username:
type: string
entity_id:
type: string
account_memberships:
type: array
items:
$ref: '#/components/schemas/AccountMembershipRepresentation'
team_memberships:
type:
- array
- 'null'
items:
$ref: '#/components/schemas/TeamMemberRepresentation'
title: UserInvite
AccountMembershipRepresentationCreateRequestType:
type: string
enum:
- ADMIN
- USER
- PARTNER
description: The type of this membership
title: AccountMembershipRepresentationCreateRequestType
UserInviteCreateRequest:
type: object
properties:
username:
type: string
entity_id:
type: string
account_memberships:
type: array
items:
$ref: '#/components/schemas/AccountMembershipRepresentationCreateRequest'
team_memberships:
type:
- array
- 'null'
items:
$ref: '#/components/schemas/TeamMemberRepresentationCreateRequest'
title: UserInviteCreateRequest
AccountRepresentation:
type: object
properties:
id:
type: string
description: The id of the account
reference:
type: string
description: The reference of the account
account_type_code:
type: string
description: The type code of the account
environment:
type: string
description: The environment of this account
account_group_id:
type: string
description: The id of the account group that this account is associated with
parent_id:
type:
- string
- 'null'
description: The id of the parent account of this account
platform_id:
type:
- string
- 'null'
description: The id of the platform that this account belongs to
title: AccountRepresentation
User:
type: object
properties:
object_type:
type:
- string
- 'null'
id:
type:
- string
- 'null'
description: The id of the user
entity_id:
type:
- string
- 'null'
description: The entity id of the entity that this user belongs to
created_at:
type:
- string
- 'null'
description: The date when this user was created
active:
type:
- boolean
- 'null'
description: Indicates whether the user is active
status:
oneOf:
- $ref: '#/components/schemas/UserStatus'
- type: 'null'
description: Indicates whether the user is active
account_memberships:
type:
- array
- 'null'
items:
$ref: '#/components/schemas/AccountMembershipRepresentation'
description: The account memberships that this user has
team_memberships:
type:
- array
- 'null'
items:
$ref: '#/components/schemas/TeamMemberRepresentation'
description: The team memberships that this user has
username:
type: string
description: The email of the user
password:
type:
- string
- 'null'
description: The password of the user. Should have a minimum of 8 characters, of which one is a number and one is a capital letter
invite_expired:
type:
- boolean
- 'null'
description: Indicates whether the invite sent to the user is expired
title: User
ApiErrorResourceType:
type: string
enum:
- CUSTOMER
- CUSTOM_FIELD
- PLATFORM
- PLATFORM_UPTODATE
- METER
- METER_VALUE
- METER_PROPERTY
- METER_VALUE_CALCULATION
- INGEST_DATA
- METER_DATA
- CHARGE_DATA
- PERSIST_DATA
- ADJUSTMENT_DATA
- PRODUCT_CATEGORY
- PRODUCT
- PRODUCT_ITEM
- PRICING
- PRICING_GROUP
- PRICING_ITEM
- PRICING_ITEM_CONFIG
- PRICING_PLAN_SUBSCRIPTION
- PRICING_PLAN_SUBSCRIPTION_GROUP
- PRICING_PLAN_SCHEDULE
- PRICING_PLAN
- PRICING_PLAN_VERSION
- QUOTE
- QUOTE_VERSION
- QUOTE_TEMPLATE
- API_KEY
- USER
- ROLE
- PROXY_USER
- EXTERNAL_CREDENTIALS
- TOKEN
- INVOICE
- E_INVOICE
- PDF
- BILLING_ENTITY
- FEATURE
- MEMBERSHIP
- PAYMENT
- PAYMENT_ACCEPTOR
- PAYMENT_METHOD
- PAYMENT_METHOD_OPTIONS
- PAYMENT_SCHEDULE
- PAYMENT_REQUEST
- INTEGRATION
- WEBHOOK
- FILE
- FILE_PROCESSING_SETTINGS
- TEAM
- DOWNLOAD_URL
- CSV_REPORT
- REPORT
- REPORT_GENERATE_REQUEST
- REPORT_CONFIGURATION
- REPORT_SUBSCRIPTION
- REPORT_DEFINITION
- ACCOUNT_GR
# --- truncated at 32 KB (41 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/solvimon/refs/heads/main/openapi/solvimon-users-api-openapi.yml