Cloudpepper Users API
The Users API from Cloudpepper — 3 operation(s) for users.
The Users API from Cloudpepper — 3 operation(s) for 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/cloudpepper-io:cloudpepper-io-users-api"
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.
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: Cloudpepper Io Users API
version: 1.0.0
description: 'Operations tagged Users across 2 of this provider''s published API definitions: cloudpepper-io-openapi.json, cloudpepper-io-openapi.yml. Each path carries the servers of the definition it was published in.'
servers:
- url: /
- url: https://api.cloudpepper.io
description: Resolved from the published relative server "/" against the host serving the spec (https://api.cloudpepper.io/openapi.json)
security:
- bearerAuth: []
tags:
- name: Users
paths:
/users:
get:
tags:
- Users
summary: List all users
description: 'Get a complete list of all users based on your access level. This gives you an overview of everyone who can access your Odoo instances, along with their roles, permissions, and account details. Perfect for auditing your team members and managing who has access to what.
**Returns Information About:**
- User email addresses
- Assigned roles and specific permissions
- Account details like creation date and last login time
- Verification status
NOTE: Results may vary depending on your access level.'
responses:
'200':
description: Users retrieved successfully
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/User'
example:
- role: admin
permissions: null
email: admin@email.com
emailVerified: true
metadata:
createdAt: '2023-10-17T19:54:59+00:00'
lastLoginAt: '2023-02-06T11:45:56+00:00'
passwordUpdatedAt: '2023-10-18T08:19:28+00:00'
lastRefreshAt: '2023-02-14T22:15:59+00:00'
mfaInfo: null
uid: 89ZPPREEKUTGIddKRqK0og7BX2
- role: user
permissions:
instances:
- instance-id-1
- instance-id-2
email: user@example.com
emailVerified: true
metadata:
createdAt: '2023-11-05T14:27:33+00:00'
lastLoginAt: '2023-02-12T09:43:21+00:00'
passwordUpdatedAt: '2023-11-06T10:15:42+00:00'
lastRefreshAt: '2023-02-14T08:22:17+00:00'
mfaInfo: null
uid: 7YXMq2rNPOTlfRsSt9pJwzAx1F
'403':
description: Insufficient permissions to view users
operationId: getUsers
x-operation-id-source: derived
post:
tags:
- Users
summary: Create a new user
description: 'Add a new team member to your Account with just a few steps. You can create accounts for colleagues, clients, or contractors, and control exactly what they can access by assigning specific roles. The new user will receive immediate access to your system based on the permissions you grant them.
**Key Parameters:**
- `email`: Email address for the new user
- `password`: Initial password for the user''s account
- `role`: Access level to assign (e.g., ''Administrator'' for admin level access, ''Full'' for complete access, ''Readonly'' for limited access, ''custom'' for customizing access level)
NOTE: You must have administrator privileges to add new users. Choose a strong password for security, and be mindful of the role you assign as it determines what actions the user can perform.'
requestBody:
content:
application/json:
schema:
type: object
properties:
email:
type: string
description: Email address for the new user account
example: newuser@example.com
password:
type: string
description: Initial password for the user account
example: SecureP@ssword123
role:
type: string
description: Role to assign to the user within the tenant
example: USER
required:
- email
- password
- role
required: true
responses:
'200':
description: User created successfully
content:
application/json:
schema:
type: object
properties:
uid:
type: string
description: Unique identifier for the newly created user
example:
uid: e5c8f0ae-7c4d-45d2-b7a3-5f9b35e1c3c2
'400':
description: Invalid input data (e.g., email already exists or invalid password)
content:
application/json:
schema:
type: object
properties:
errors:
type: object
example:
errors:
email: The email address is already in use
'403':
description: Insufficient permissions (requires admin privileges)
operationId: postUsers
x-operation-id-source: derived
servers:
- url: /
/users/{id}/reset-password:
parameters:
- name: id
in: path
description: User ID
required: true
schema:
type: string
post:
tags:
- Users
summary: Send password reset email
description: 'Help a user who has forgotten their password by sending them a secure reset link. The system will email the user with instructions on how to create a new password. This feature is perfect for supporting team members who are locked out of their accounts.
NOTE: The password reset link will be sent directly to the user''s registered email address and will expire after a limited time for security. After resetting their password, the user will be directed to the login page.'
responses:
'200':
description: Password reset email sent successfully
content:
application/json:
schema:
type: object
properties:
uid:
type: string
description: Unique identifier of the user
example:
uid: e5c8f0ae-7c4d-45d2-b7a3-5f9b35e1c3c2
'403':
description: Insufficient permissions (requires admin privileges)
'404':
description: User not found
operationId: postUsersByIdResetPassword
x-operation-id-source: derived
servers:
- url: /
/users/{id}:
parameters:
- name: id
in: path
description: User ID
required: true
schema:
type: string
put:
tags:
- Users
summary: Update user access level
description: 'Adjust a user''s access level within your Account. This lets you promote users to administrators, restrict access for certain team members, or create custom permission sets for specific servers and instances. Any changes you make take effect immediately.
**Key Parameters:**
- `role`: New role to assign to this user (e.g., ''admin'', ''full'', ''readonly'', ''custom'').
- `permissions`: Object specifying per-resource access levels, required when `role` is `custom`. Keys are clouds_ / instances_, values are `read` (read-only permissions) or `write` (full permissions).'
requestBody:
content:
application/json:
schema:
type: object
properties:
role:
type: string
description: Role to assign to the user
enum:
- admin
- full
- readonly
- custom
example: custom
permissions:
type: object
description: Custom permissions configuration (required when role is 'custom'). Keys are `clouds_<server_ID>` or `instances_<instance_ID>`, values are the access level for that resource.
additionalProperties:
type: string
enum:
- read
- write
description: 'Access level for the resource: `read` for read-only permissions, `write` for full permissions'
example:
clouds_550e8400-e29b-41d4-a716-446655440000: write
instances_c2e36700-a18f-48bc-9092-d09c335f4fa8: read
required:
- role
required: true
responses:
'200':
description: User updated successfully
content:
application/json:
schema:
type: object
properties:
uid:
type: string
description: Unique identifier of the updated user
example:
uid: e5c8f0ae-7c4d-45d2-b7a3-5f9b35e1c3c2
'403':
description: Insufficient permissions (requires admin privileges)
'404':
description: User not found
operationId: putUsersById
x-operation-id-source: derived
delete:
tags:
- Users
summary: Delete a user
description: 'Remove a user''s access to your tenant completely. Use this when someone leaves your team or no longer needs access to your Odoo instances. Once deleted, the user will immediately lose all access to your systems.
NOTE: This action cannot be undone! The user account will be permanently removed from your tenant. If the person needs access again in the future, you''ll need to create a new account for them.'
responses:
'200':
description: User deleted successfully
content:
application/json:
schema:
type: object
properties:
uid:
type: string
description: Unique identifier of the deleted user
example:
uid: e5c8f0ae-7c4d-45d2-b7a3-5f9b35e1c3c2
'403':
description: Insufficient permissions (requires admin privileges)
'404':
description: User not found
operationId: deleteUsersById
x-operation-id-source: derived
servers:
- url: /
components:
schemas:
User:
type: object
properties:
uid:
type: string
email:
type: string
emailVerified:
type: boolean
displayName:
type: string
required: false
phoneNumber:
type: string
required: false
metadata:
type: object
properties:
createdAt:
type: string
lastLoginAt:
type: string
passwordUpdatedAt:
type: string
lastRefreshAt:
type: string
securitySchemes:
bearerAuth:
type: http
scheme: bearer
bearerFormat: JWT
x-refined-from:
- cloudpepper-io-openapi.json
- cloudpepper-io-openapi.yml