Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Need help?

Contact us
Kin Lane

Chat with Kin

AI assistant · trained on my blog

Tessell

Tessell Users API

The Users API from Tessell — 17 operation(s) for users.

Documentation Provider Profile APIs.io OpenAPI GitHub

Tessell Users API is one of 82 APIs that Tessell publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Users. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, an API reference, and a getting-started guide.

This API exposes 18 operations across 17 paths, and defines 38 schemas. It is described by OpenAPI 3.0.3, at version 1.0.

Requests are made against a single base URL, {server}.

18 operations 17 paths 38 schemas 1 DELETE2 GET2 PATCH13 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.3
API Version
1.0
Base URL
https://api.console.tessell.com
Authentication
HTTP Bearer
Contact
Tessell Inc
Terms of Service
View terms
Resource Areas
1

Authentication & Security 1

Tessell Users API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (BearerAuth).

Paths & Operations 18

Across 17 paths, the API surfaces 18 operations — 1 DELETE, 2 GET, 2 PATCH, 13 POST. Each is listed below with its method, path, parameters, and response codes.

Users 18
GET
/iam/users
Get list of all the users
getUsers 10 params → 200default
POST
/iam/users/invite-user
Create for a new user
inviteUser 2 params body → 200201default
POST
/iam/users/accept-invite
Accept invite
acceptInvite 1 param body → 200default
POST
/iam/users/change-password
Change current user's password
changePassword 1 param body → 200201default
POST
/iam/users/force-reset-password
Forcefully reset password for a user
forceResetPassword 1 param body → 200201default
POST
/iam/users/login
Login a user
login 1 param body → 200201default
POST
/iam/users/refresh-token
Acquire new access-token using refresh-token
refreshToken 2 params → 200default
POST
/iam/users/logout
Logout a user
logout 1 param → 200201default
POST
/iam/users/forgot-password/{email-id}
Forgot Password
forgotPassword 2 params → 200default
POST
/iam/users/reset-password
Reset password for a user
resetPassword 1 param body → 200default
POST
/iam/users/reset-password-on-expiry
Reset password for a user when password has been expired
resetPasswordOnExpiry 1 param body → 200default
GET
/iam/users/whoami
Get details of a user
whoami 1 param → 200default
DELETE
/iam/users/{email-id}
Delete a user
delete 3 params → 200204default
PATCH
/iam/users/{email-id}
Update a user
adminUpdateUser 3 params body → 200default
PATCH
/iam/users/profile
Update self profile
updateUserProfile 1 param body → 200default
POST
/iam/users/{email-id}/change-status
Change status of a user
changeStatus 2 params body → 200201default
POST
/iam/users/session/mfa/verify
Verifies the multi factor authentication based otp
verifyMfa 1 param body → 200default
POST
/iam/users/session/mfa/resend
Resend the totp for mfa verification
resendMfaOtp 1 param → 200default

Schemas 38

The contract defines 38 schemas that model the data the API accepts and returns. The most detailed are TenantUserServiceConsumerAttributes (11 properties), TenantUserAttributes (11 properties), LoginUserResponse (10 properties), ApiError (7 properties). Each schema is shown below with its type and property counts.

UserServiceConsumerDTO
object
This is a definition for Tessell user object for service consumers
7 properties
FirstName
string
First name of the user
apiStatus
object
2 properties
ApiError
object
Common error response object for non 2xx responses
7 properties
ResetPasswordPayload
object
This is a definition for Tessell's user password reset payload
3 properties 3 required
LoginUserPayload
object
This is a definition for Tessell login user object
3 properties 2 required
EmailId
string
Email Id of the user
apiPaginationInfo
object
2 properties
MfaSessionToken
string
Temporary session token (JWT) to validate the user trying to login through mfa
UserPersonaServiceConsumerDTO
object
This is a definition for Tessell user persona DTO object
2 properties
UserAppFeatures
object
This is a definition for Tessell user's apps object
3 properties
AcceptInviteUserPayload
object
This is a definition for accept invite payload
6 properties 5 required
UserStatus
string
This is a definition for Tessell userpool type object
IamApiResponse
object
2 properties
UpdateUserProfilePayload
object
This is a definition for Tessell's user update profile payload object
2 properties
LoginUserResponse
object
This is a definition for Tessell login user response object
10 properties
ChangePasswordPayload
object
This is a definition for Tessell's user password update payload object
2 properties 2 required
UserSubscriptionDTO
object
This is a definition for Tessell user subscription DTO object
2 properties
apiMetadata
object
3 properties
UserPersonaDTO
object
This is a definition for Tessell user persona DTO object
3 properties
Password
string
Password of the user
TenantUserServiceConsumerAttributes
object
This is a definition for Tessell user persona DTO object
11 properties
UserAppsDTO
object
This is a definition for Tessell user's apps object
3 properties
MfaVerificationPayload
object
Payload for the MFA verification
1 property 1 required
ResetPasswordOnExpiryPayload
object
This is a definition for Tessell's user password reset payload while Password Expired
3 properties 3 required
RefreshTokenResponse
object
Response of Refresh Token API
1 property
UpdateUserPayload
object
This is a definition for Tessell's user update payload object
2 properties
ChangeStatusPayload
object
This is a definition for Tessell's user status update payload object
1 property
NewPassword
string
New password of the user
TenantUserAttributes
object
This is a definition for Tessell user persona DTO object
11 properties
LastName
string
Last name of the user
InviteUserPayload
object
This is a definition for Tessell's user payload object
3 properties 1 required
ForceResetPasswordPayload
object
This is a definition for Tessell user's force password reset payload object
2 properties 2 required
consumerType
string
Tessell Consumer Type
AuthType
string
This is a definition for Tessell's auth type status object
MfaVerificationMethod
string
Verification method for Multi Factor Authentication
UserAccessControlFlags
string
OldPassword
string
Old password of the user

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

tessell-users-api-openapi.yml Raw ↑

Other APIs Tessell publishes across the network.

Tessell activity-center API
AE Profile APIs.io
Tessell Ad Domain API
AE Profile APIs.io
Tessell Ad Domain Governance API
AE Profile APIs.io
Tessell agentController API
AE Profile APIs.io
Tessell alert-controller API
AE Profile APIs.io
Tessell Authorization API
AE Profile APIs.io
Tessell Availability Machine API
AE Profile APIs.io
Tessell azure-netapp-admin-controller API
AE Profile APIs.io
Tessell azure-netapp-service-controller API
AE Profile APIs.io
Tessell cloud-resource API
AE Profile APIs.io
Tessell Compute API
AE Profile APIs.io
Tessell Compute Governance API
AE Profile APIs.io
#Users
← Back to T APIs
API Details
ID
tessell:tessell-users-api
Base URL
https://api.console.tessell.com
Docs
https://developer.tessell.com/
Provider
Tessell
APIs.io →  GitHub →
Explore more
All APIs Providers APIs.io Network