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

Alphaus Iam API

(BETA) IAM API. Base URL: https://api.alphaus.cloud/m/blue

Alphaus Iam API is one of 15 APIs that Alphaus publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include IAM. The published artifact set on APIs.io includes an OpenAPI specification.

This API exposes 39 operations across 27 paths, and defines 48 schemas. It is described by OpenAPI 3.2.0, at version v1.

Requests are made against a single base URL, https://api.alphaus.cloud/m/blue.

39 operations 27 paths 48 schemas 6 DELETE15 GET14 POST4 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
v1
Base URL
https://api.alphaus.cloud/m/blue
Resource Areas
1

Paths & Operations 39

Across 27 paths, the API surfaces 39 operations — 6 DELETE, 15 GET, 14 POST, 4 PUT. Each is listed below with its method, path, parameters, and response codes.

Iam 39

(BETA) IAM API. Base URL: https://api.alphaus.cloud/m/blue

GET
/iam/v1/apiclients
Lists all API clients belonging to the caller.
Iam_ListApiClients → 200default
POST
/iam/v1/apiclients
Creates an API client for the caller.
Iam_CreateApiClient body → 200default
DELETE
/iam/v1/apiclients/{id}
Deletes an API client belonging to the caller.
Iam_DeleteApiClient 1 param → 200default
GET
/iam/v1/experimentalui/preferences
Gets experimental UI preferences for the authenticated MSP.
Iam_GetExperimentalUIPreferences → 200default
PUT
/iam/v1/experimentalui/preferences/{componentId}
Creates or updates an experimental UI preference for a specific component.
Iam_UpsertExperimentalUIPreference 1 param body → 200default
GET
/iam/v1/grouprootusers
WORK-IN-PROGRESS: Retrieves all the existing group root users asscoiated with the organization.
Iam_ListGroupRootUsers → 200default
POST
/iam/v1/grouprootusers
WORK-IN-PROGRESS: Creates a new root user for a billing group or access group.
Iam_CreateGroupRootUser body → 200default
GET
/iam/v1/grouprootusers/{id}
WORK-IN-PROGRESS: Retrieves a group root user.
Iam_GetGroupRootUser 1 param → 200default
DELETE
/iam/v1/grouprootusers/{id}
WORK-IN-PROGRESS: Deletes an existing group root user.
Iam_DeleteGroupRootUser 1 param → 200default
GET
/iam/v1/grouprootusers/{id}/features
WORK-IN-PROGRESS: Retrieves the features available to a user on an Alphaus product.
Iam_GetFeatureFlags 1 param → 200default
PUT
/iam/v1/grouprootusers/{id}/features
WORK-IN-PROGRESS: Updates the features available to a user on an Alphaus product.
Iam_UpdateFeatureFlags 1 param body → 200default
GET
/iam/v1/idps
Lists all SSO Identity Providers (IdP).
Iam_ListIdentityProviders → 200default
POST
/iam/v1/idps
Registers an SSO Identity Provider (IdP).
Iam_CreateIdentityProvider body → 200default
DELETE
/iam/v1/idps/{id}
Deletes an SSO Identity Provider (IdP).
Iam_DeleteIdentityProvider 1 param → 200default
GET
/iam/v1/ipfilters
Lists all IP filters. At the moment, this API is only available to root users.
Iam_ListIpFilters → 200default
POST
/iam/v1/ipfilters
Creates an IP filter item for IP blacklisting or whitelisting. At the moment, this API is only available to root users.
Iam_CreateIpFilter body → 200default
DELETE
/iam/v1/ipfilters/{id}
Deletes an IP filter item. At the moment, this API is only available to root users.
Iam_DeleteIpFilter 1 param → 200default
GET
/iam/v1/metadata/{id}
WORK-IN-PROGRESS: Get Sub User Metadata for login user's organization based on user identity
Iam_GetSubUserMetadata 2 params → 200default
GET
/iam/v1/mfausers
WORK-IN-PROGRESS: List MFA users info for login user's organization based on status.
Iam_GetMFAUsers 1 param → 200default
POST
/iam/v1/partners/{id}/token
BETA: Creates a partner token for custom integrations. Available only to Ripple and Cover users.
Iam_CreatePartnerToken 1 param body → 200default
POST
/iam/v1/partners/{id}/token:refresh
BETA: Refreshes an expired partner token. Only partners are expected to call this API.
Iam_RefreshPartnerToken 1 param body → 200default
POST
/iam/v1/password:reset
WORK-IN-PROGRESS: Validate reset password link and proceed to update password
Iam_ValidateResetPasswordLinkAndChangePassword body → 200default
GET
/iam/v1/permissions
WORK-IN-PROGRESS: Lists all permissions based on the input's scope. For reference, supported permissions can be found on [https://github.com/mobingi/rbac-permissions].
Iam_ListPermissions 1 param → 200default
POST
/iam/v1/ripple/password:requestresetcode
WORK-IN-PROGRESS: Send an email reset code
Iam_SendRipplePasswordResetCode body → 200default
POST
/iam/v1/ripple/password:reset
WORK-IN-PROGRESS: Reset ripple password using code from email
Iam_ResetRipplePassword body → 200default
GET
/iam/v1/roles
WORK-IN-PROGRESS: Lists all available roles.
Iam_ListRoles 1 param → 200default
POST
/iam/v1/roles
WORK-IN-PROGRESS: Creates a role. If your permissions list contains an Admin entry, all other entries will be discarded except Admin. Roles are root user-level. That means all roles created by the ro…
Iam_CreateRole body → 200default
DELETE
/iam/v1/roles/{namespace}/{name}
WORK-IN-PROGRESS: Deletes a role. Deleting a role will also remove all mappings.
Iam_DeleteRole 2 params → 200default
PUT
/iam/v1/roles/{namespace}/{name}
WORK-IN-PROGRESS: Updates a role. If role name is different, rename mapped role name.
Iam_UpdateRole 2 params body → 200default
GET
/iam/v1/userroles
WORK-IN-PROGRESS: Lists roles attached to the caller or the input.
Iam_ListUserRoleMappings 1 param → 200default
POST
/iam/v1/userroles
WORK-IN-PROGRESS: Maps roles to a subuser. You can only map (or attach) up to 5 roles to a user per namespace. There is no limit for filtering rules per user.
Iam_CreateUserRoleMapping body → 200default
PUT
/iam/v1/userroles
WORK-IN-PROGRESS: Updates user-to-role mappings. You can only map (or attach) up to 5 roles to a user per namespace. There is no limit for filtering rules per user.
Iam_UpdateUserRoleMapping body → 200default
GET
/iam/v1/users
Lists all subusers.
Iam_ListUsers → 200default
POST
/iam/v1/users
Creates a subuser.
Iam_CreateUser body → 200default
GET
/iam/v1/users/{id}
Gets subuser information. This call includes all of the subuser metadata. See [https://alphauslabs.github.io/blueapi/] for the list of supported attributes. If the {name} parameter is me or -, return…
Iam_GetUser 1 param → 200default
DELETE
/iam/v1/users/{id}
Deletes a subuser.
Iam_DeleteUser 1 param → 200default
GET
/iam/v1/whoami
Gets user information about the caller. This call includes all of the user metadata. See [https://alphauslabs.github.io/blueapi/] for the list of supported attributes.
Iam_WhoAmI → 200default
POST
/iam/v1/{domain}/account:unlock
WORK-IN-PROGRESS: Unlocks ripple or wave user account.
Iam_UnlockUserAccount 1 param body → 200default
POST
/iam/v1/{user}/password:verify
WORK-IN-PROGRESS: Verify User Input For Reset Password
Iam_VerifyUserForResetPassword 1 param → 200default

Schemas 48

The contract defines 48 schemas that model the data the API accepts and returns. The most detailed are apiFeatureFlags (35 properties), apiGroupRootUser (13 properties), v1CreateGroupRootUserRequest (8 properties), apiApiClient (6 properties). Each schema is shown below with its type and property counts.

v1UpdateUserRoleMappingResponse
object
Response message for the Iam.UpdateUserRoleMapping rpc.
3 properties
apiSubUser
object
4 properties
v1ValidateResetPasswordLinkAndChangePasswordRequest
object
Request for message Iam.ValidateVerificationCode rpc.
2 properties
protobufAny
object
Any contains an arbitrary serialized protocol buffer message along with a URL that describes the type of the serialized message. Protobuf library provides supp…
1 property
apiSubUserRole
object
3 properties
v1CreateGroupRootUserRequest
object
8 properties
blueapiApiRole
object
4 properties
ListIdentityProvidersResponseIdentityProvider
object
4 properties
v1ResetRipplePasswordResponse
object
2 properties
IamUnlockUserAccountBody
object
3 properties
IamUpdateRoleBody
object
Request message for the Iam.UpdateRole rpc.
2 properties
v1ListRolesResponse
object
Response message for the Iam.ListRoles rpc.
1 property
IamUpdateFeatureFlagsBody
object
Request message for the Iam.UpdateFeatureFlags rpc.
1 property
v1IpFilter
object
5 properties
v1ResetRipplePasswordRequest
object
2 properties
v1ValidateResetPasswordLinkAndChangePasswordResponse
object
Response for message Iam.ValidateVerificationCode rpc.
3 properties
v1MFAUsersInfoResponse
object
Response message for the MFAUsersInfoResponse rpc.
1 property
v1CreateUserRequest
object
Request message for the Iam.CreateUser rpc.
4 properties
v1VerifyUserForResetPasswordResponse
object
Response message for Iam.VerifyUserForResetPassword rpc.
1 property
IamUpsertExperimentalUIPreferenceBody
object
Request message for the Iam.UpsertExperimentalUIPreference rpc.
2 properties
IdentityProvidersamlInfo
object
1 property
apiFeatureFlags
object
Describes the features and whether or not they are enabled for a particular user.
35 properties
IamCreatePartnerTokenBody
object
Request message for the Iam.CreatePartnerToken rpc.
v1ExperimentalUIPreference
object
ExperimentalUIPreference holds the UI version preference and banner state for a single component.
4 properties
v1ListPermissionsResponse
object
Response message for the Iam.ListPermissions rpc.
1 property
v1CreateIpFilterRequest
object
Request message for the Iam.CreateIpFilter rpc.
4 properties
v1CreateIdentityProviderRequest
object
Request message for the Iam.CreateIdentityProvider rpc.
3 properties
v1ListIdentityProvidersResponse
object
Response message for the Iam.ListIdentityProviders rpc.
1 property
v1MFAUser
object
5 properties
v1UpsertExperimentalUIPreferenceResponse
object
Response message for the Iam.UpsertExperimentalUIPreference rpc.
1 property
rpcStatus
object
The Status type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](h…
3 properties
apiPolicy
object
4 properties
v1CreateUserRoleMappingRequest
object
Request message for the Iam.CreateUserRoleMapping rpc.
2 properties
v1GetExperimentalUIPreferencesResponse
object
Response message for the Iam.GetExperimentalUIPreferences rpc.
1 property
v1ListUserRoleMappingsResponse
object
Response message for the Iam.ListUserRoleMappings rpc.
1 property
v1CreateRoleRequest
object
Request message for the Iam.CreateRole rpc.
3 properties
v1SendRipplePasswordResetCodeRequest
object
1 property
v1CreateUserRoleMappingResponse
object
Response message for the Iam.CreateUserRoleMapping rpc.
3 properties
IamRefreshPartnerTokenBody
object
Request message for the Iam.RefreshPartnerToken rpc.
1 property
apiPermission
object
3 properties
v1UpdateUserRoleMappingRequest
object
Request message for the Iam.UpdateUserRoleMapping rpc.
2 properties
v1CreateApiClientRequest
object
Request message for the Iam.CreateApiClient rpc.
1 property
v1MapRole
object
2 properties
apiGroupRootUser
object
Describes the fields on an Alphaus root user for a billing group or access group.
13 properties
v1PartnerToken
object
1 property
apiUserRoleMapping
object
5 properties
blueapiApiUser
object
3 properties
apiApiClient
object
6 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

alphaus-iam-api-openapi.yml Raw ↑

Other APIs Alphaus publishes across the network.

Alphaus Admin API
Alphaus Billing API
Alphaus Cost API
Alphaus Cover API
Alphaus Flags API
Alphaus Flow API
Alphaus GuaranteedCommitments API
Alphaus Luster API
Alphaus Operations API
Alphaus Organization API
Alphaus Preferences API
Alphaus Pricing API
Where this information came from

This is an independent, third-party profile of Alphaus Iam 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.