How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Volumez User API

The user API from Volumez — 23 operation(s) for user.

Volumez User API is one of 39 APIs that Volumez publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

This API exposes 1 JSON Schema definition.

Tagged areas include User. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, authentication docs, rate-limit docs, and 1 JSON Schema.

This API exposes 26 operations across 23 paths, and defines 25 schemas. It is described by OpenAPI 3.2.0, at version 1.0.0 - 8d1ee8c4.

Requests are made against a single base URL, https://api.dev.volumez.com.

26 operations 23 paths 25 schemas 2 DELETE11 GET12 POST1 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
1.0.0 - 8d1ee8c4
Base URL
https://api.dev.volumez.com
Authentication
API Key
Resource Areas
1

Authentication & Security 1

Volumez User API declares 1 security scheme for authenticating requests. An API key is passed in the header as authorization (storage.io-authorizer).

Paths & Operations 26

Across 23 paths, the API surfaces 26 operations — 2 DELETE, 11 GET, 12 POST, 1 PUT. Each is listed below with its method, path, parameters, and response codes.

User 26
POST
/signup
Create Tenant's first user
SignUp body → 200401500
POST
/signout
Signs out user from all devices
signOut body → 200401500
POST
/signin
User SignIn
signIn body → 200400404500
GET
/tenant/user
Get user details
getTenantUser 1 param → 200500
POST
/tenant/user
Create Tenant's additional user
TenantUserCreate 1 param body → 200500
POST
/tenant/user/requestchangepassword
Request change client password
requestChangePassword body → 200500
POST
/tenant/user/changepassword
Change client password
approveChangePassword body → 200500
POST
/tenant/user/changepasswordloggedin
Change clients password when user is logged in
ChangePasswordLoggedIn 1 param body → 200500
GET
/tenant/user/confirmation
Confirm user signup
userConfirm 3 params → 200500
POST
/add-user
Add user to tenant group users
addUser body → 200500
POST
/disable-user/{email}
disable user
disableUser 2 params → 200500
POST
/enable-user/{email}
enable user
enableUser 2 params → 200500
POST
/invite-user/{email}
invite a user to join tenant (send add user signup email
inviteUser 2 params → 200500
GET
/users/{tenantId}
List all tenant group users
TenantUsers 2 params → 200500
GET
/azuremarketplace/subscription
get subscription
GetSubscription 1 param → 200404500
POST
/tenant/refreshtoken
Get tenant refresh token
getTenantRefreshToken body → 500200
GET
/tenant/token
Get tenant access token
getTenantAccessToken 1 param → 500200
GET
/tenant/tenantid
Get tenant ID from tenant token
GetTenantIDFromTenantToken 1 param → 500200
DELETE
/tenant/{tenantID}/tenanthosts/{tenantHost}
Delete tenant host
deleteTenantHost 3 params → 500200
GET
/tenant/tenanthost/credentials
Tenant host access credentials
TenantHostAccessCredentials 2 params → 500200
GET
/tenant/tenanthost
Get tenant host
getTenantHost 2 params → 500200
GET
/tenant/apiaccess/credentials/refresh
Refresh tenant API access credentials
RefreshTenantAPIAccessCredentials 1 param → 500200
DELETE
/sso/azure/mapping
Delete Azure SSO Mapping
deleteAzureSSOMapping 1 param → 204500
GET
/sso/azure/mapping
Get Azure SSO Mapping
getAzureSSOMapping 1 param → 200500
PUT
/sso/azure/mapping
Put Azure SSO Mapping
putAzureSSOMapping 1 param body → 204500
GET
/sso/callback/{userPoolID}/{applicationClientId}
Handle SSO callback
handleSSOCallback 3 params → 302500

Schemas 25

The contract defines 25 schemas that model the data the API accepts and returns. The most detailed are TenantUser (6 properties), SignInResponse (5 properties), GetTenantUserResponse (5 properties), ChangePasswordRequestLoggedIn (5 properties). Each schema is shown below with its type and property counts.

RefreshToken
object
1 property
CreateAddTenantUserRequest
object
4 properties 4 required
SignInRequest
object
2 properties 2 required
GetTenantIDResponse
object
3 properties 1 required
RegularResponse
object
1 property
InviteUserResponse
object
4 properties 4 required
SignInResponse
object
5 properties 5 required
GetAzureSSOMappingResponse
object
1 property 1 required
EmptyResponse
object
TenantHostDeleteResponse
object
2 properties 1 required
ErrorResponse
object
1 property
PutAzureSSOMappingRequest
object
1 property 1 required
TenantUser
object
6 properties 5 required
SignUpRequest
object
5 properties 3 required
GetTenantHostResponse
object
4 properties 1 required
SignUpResponse
object
2 properties 1 required
RefreshTokenResponse
object
5 properties
GetTenantUserResponse
object
5 properties
AddUserRequest
object
4 properties 4 required
ChangePasswordApproveRequest
object
3 properties
RequestChangePassword
object
1 property
TenantTokenResponse
object
3 properties 3 required
ChangePasswordRequestLoggedIn
object
5 properties
GetTenantRefreshTokenRequest
object
3 properties 2 required
SignOutRequest
object
1 property 1 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

volumez-user-api-openapi.yml Raw ↑

Other APIs Volumez publishes across the network.

Volumez Add User API
Volumez Alerts API
Volumez Associations API
Volumez Attachments API
Volumez Auth API
Volumez Auto Provision Volumes API
Volumez Azuremarketplace API
Volumez Capacity Groups API
Volumez Charts API
Volumez Connectivities API
Volumez Disable User API
Volumez Enable User API
Where this information came from

This is an independent, third-party profile of Volumez User API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.