Cloudera IAM API
Users, machine users, groups, roles, resource roles, access keys, SAML identity providers and SCIM access tokens for a CDP account. 79 operations.
Cloudera IAM API is one of 24 APIs that Cloudera publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
Tagged areas include IAM, Identity, SAML, and SCIM. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and an API reference.
This API exposes 79 operations across 79 paths, and defines 181 schemas. It is described by OpenAPI 2.0, at version 0.9.163.
Requests are made against the base URL https://api.us-west-1.cdp.cloudera.com.
79 operations
79 paths
181 schemas
79 POST
Metadata
The identity and technical contract details declared by the specification.
Paths & Operations 79
Across 79 paths, the API surfaces 79 operations — 79 POST. Each is listed below with its method, path, parameters, and response codes.
Operations 79
POST
/iam/getUser
Gets information on a user.
POST
/iam/listUsers
Lists users.
POST
/iam/createUser
Creates a user in CDP.
POST
/iam/updateUser
Updates a user.
POST
/iam/deleteUser
Deletes a user and all associated resources.
POST
/iam/createUserAccessKey
Creates a new access key for a user.
POST
/iam/createMachineUserAccessKey
Creates a new access key for a machine user.
POST
/iam/deleteAccessKey
Deletes an access key.
POST
/iam/updateAccessKey
Updates an access key.
POST
/iam/getAccessKey
Gets information on an access key.
POST
/iam/listAccessKeys
Lists access keys.
POST
/iam/listRoles
Lists all the available roles.
POST
/iam/listResourceRoles
Lists all the available resource roles.
POST
/iam/setAccountMessages
Set messages for an account.
POST
/iam/getAccountMessages
Get account messages.
POST
/iam/assignUserRole
Assign a role to a user.
POST
/iam/unassignUserRole
Unassign a role from a user.
POST
/iam/assignUserResourceRole
Assign a resource role to a user.
POST
/iam/unassignUserResourceRole
Unassign a resource role from a user.
POST
/iam/listUserAssignedRoles
Lists the user's assigned roles.
POST
/iam/listUserAssignedResourceRoles
Lists a user's assigned resource roles.
POST
/iam/assignMachineUserRole
Assign a role to a machine user.
POST
/iam/unassignMachineUserRole
Unassign a role from a machine user.
POST
/iam/assignMachineUserResourceRole
Assign a resource role to a machine user.
POST
/iam/unassignMachineUserResourceRole
Unassign a resource role from a machine user.
POST
/iam/listMachineUserAssignedRoles
Lists the machine user's assigned roles.
POST
/iam/listMachineUserAssignedResourceRoles
Lists a machine user's assigned resource roles.
POST
/iam/listResourceAssignees
List the resource assignees and their respective resource roles for the resource.
POST
/iam/createMachineUser
Create a machine user.
POST
/iam/listMachineUsers
Lists machine users.
POST
/iam/deleteMachineUser
Delete a machine user.
POST
/iam/createSamlProvider
Creates a SAML provider in CDP.
POST
/iam/deleteSamlProvider
Deletes a SAML provider in CDP account.
POST
/iam/listSamlProviders
Lists SAML providers in CDP account.
POST
/iam/describeSamlProvider
Describes one SAML provider.
POST
/iam/updateSamlProvider
Updates a SAML provider in CDP.
POST
/iam/enableClouderaSSOLogin
Enables interactive login using Cloudera SSO for this account.
POST
/iam/disableClouderaSSOLogin
Disables interactive login using Cloudera SSO for this account.
POST
/iam/getAccount
Retrieves information about the CDP account.
POST
/iam/createGroup
Create a group.
POST
/iam/deleteGroup
Delete a group.
POST
/iam/listGroups
Lists groups.
POST
/iam/updateGroup
Update a group.
POST
/iam/addUserToGroup
Add a user to a group.
POST
/iam/addMachineUserToGroup
Add a machine user to group.
POST
/iam/removeUserFromGroup
Remove a user from a group.
POST
/iam/removeMachineUserFromGroup
Remove a machine user from a group.
POST
/iam/listGroupMembers
List the members of a group.
POST
/iam/listGroupsForUser
List the groups that the user belongs to.
POST
/iam/listGroupsForMachineUser
List the groups that the machine user belongs to.
POST
/iam/assignGroupRole
Assign a role to a group.
POST
/iam/unassignGroupRole
Unassign a role from a group.
POST
/iam/assignGroupResourceRole
Assign a resource role to a group.
POST
/iam/unassignGroupResourceRole
Unassign a resource role from a group.
POST
/iam/listGroupAssignedRoles
Lists the group's assigned roles.
POST
/iam/listGroupAssignedResourceRoles
Lists a group's assigned resource roles.
POST
/iam/setWorkloadPassword
Set the workload password for an actor.
POST
/iam/unsetWorkloadPasswordMinLifetime
Removes workload password minimum lifetime date for an actor.
POST
/iam/setWorkloadPasswordPolicy
Set the workload password policy for the account.
POST
/iam/unsetWorkloadPasswordPolicy
Unset workload password policy for the account.
POST
/iam/addSshPublicKey
Adds an SSH public key for an actor.
POST
/iam/listSshPublicKeys
Lists SSH public keys for an actor.
POST
/iam/describeSshPublicKey
Describes an SSH public key for an actor.
POST
/iam/deleteSshPublicKey
Deletes an SSH public key for an actor.
POST
/iam/updateLdapProvider
UpdateLdapProvider
POST
/iam/createLdapProvider
CreateLdapProvider
POST
/iam/getDefaultIdentityProvider
Retrieves the CRN of the default identity provider.
POST
/iam/setDefaultIdentityProvider
Sets the default identity provider.
POST
/iam/generateWorkloadAuthToken
Generates an authentication token for workload APIs.
POST
/iam/createScimAccessToken
Creates a SCIM access token for a SCIM enabled identity provider.
POST
/iam/listScimAccessTokens
Lists SCIM access tokens for a SCIM enabled identity provider.
POST
/iam/deleteScimAccessToken
Deletes a SCIM access token.
POST
/iam/unlockUserInControlPlane
Unlocks user in the CDP control plane.
POST
/iam/unlockMachineUserInControlPlane
Unlocks machine user in the CDP control plane.
POST
/iam/setSamlAuthnRequestSigningKey
Sets the SAML AuthnRequest signing key and verification certificate.
POST
/iam/migrateUsersToIdentityProvider
Migrates all users from an identity provider connector to a different identity provider connector.
POST
/iam/setSamlResponseDecryptionKey
Sets encryption certificate and decryption key for SAML response sent from customer's Identity Provider to CDP.
POST
/iam/enableUserWorkloadPasswordChangedNotifications
Enables sending user workload password changed email notifications for the account.
POST
/iam/disableUserWorkloadPasswordChangedNotifications
Disables sending user workload password changed email notifications for the account.
Schemas 181
The contract defines 181 schemas that model the data the API accepts and returns. The most detailed are UpdateLdapProviderRequest (18 properties), SamlProvider (18 properties), CreateLdapProviderRequest (18 properties), LdapProviderInfo (15 properties). Each schema is shown below with its type and property counts.
Error
object
An object returned on an error.
2 properties
WorkloadPasswordPolicy
object
Information about the workload password policy for an account.
8 properties
8 required
Account
object
Information about a Cloudera CDP account.
4 properties
3 required
User
object
Information about a Cloudera CDP user.
12 properties
8 required
MachineUser
object
Information about a Cloudera CDP machine user.
6 properties
3 required
WorkloadPasswordDetails
object
Information about the workload password for a user or machine user.
3 properties
1 required
AccessKeyType
string
The version of an access key. V1 - Deprecated, use RSA as the request signing algorithm. V2 - Use ED25519 as the request signing algorithm. V3 - Use ECDSA as t…
AccessKey
object
Information about a Cloudera CDP access key.
7 properties
4 required
AccessKeyLastUsage
object
Information on the last time an access key was used.
2 properties
PolicyStatement
object
A policy statement is a list of rights and zero or more resources on which the rights are granted.
2 properties
2 required
Policy
object
A policy contains a list of one or more policy statements.
2 properties
2 required
ResourceRole
object
Information about a resource role. A resource role is a role that grants a collection of rights to a user on resources.
2 properties
2 required
Role
object
Information about a role.
2 properties
2 required
ResourceAssignment
object
Information about a resource assignment.
2 properties
2 required
ResourceAssignee
object
Information about the resource role assignee for the resource.
2 properties
2 required
Group
object
Information about a group.
4 properties
3 required
SamlProvider
object
Information used to connect a CDP account to an external identity provider.
18 properties
5 required
SshPublicKey
object
Information about an SSH public key.
4 properties
2 required
GetUserRequest
object
Request object for a get user request.
1 property
GetUserResponse
object
Response object for a get user request.
1 property
1 required
ListUsersRequest
object
Request object for a list users request.
3 properties
ListUsersResponse
object
Response object for a list users request.
2 properties
1 required
CreateUserAccessKeyRequest
object
Request object for a create user access key request.
2 properties
CreateUserAccessKeyResponse
object
Response object for a create user access key request.
2 properties
2 required
CreateMachineUserAccessKeyRequest
object
Request object for a create machine user access key request.
2 properties
1 required
CreateMachineUserAccessKeyResponse
object
Response object for a create machine user access key request.
2 properties
2 required
DeleteAccessKeyRequest
object
Request object for a delete access key request.
1 property
1 required
DeleteAccessKeyResponse
object
Response object for a delete access key request.
UpdateAccessKeyRequest
object
Request object for an update access key request.
2 properties
2 required
UpdateAccessKeyResponse
object
Response object for an update access key request.
1 property
1 required
GetAccessKeyRequest
object
Request object for a get access key request.
1 property
GetAccessKeyResponse
object
Response object for a get access key request.
1 property
1 required
ListAccessKeysRequest
object
Request object for a list access keys request.
3 properties
ListAccessKeysResponse
object
Response object for a list access keys request.
2 properties
1 required
CreateSamlProviderRequest
object
Request object for creating SAML provider request.
5 properties
1 required
CreateSamlProviderResponse
object
Response object for a creating SAML provider request.
1 property
1 required
DeleteSamlProviderRequest
object
Request object for deleting SAML provider request.
1 property
1 required
DeleteSamlProviderResponse
object
Response object for delete SAML provider request.
ListSamlProvidersRequest
object
Request object for a list SAML providers request.
3 properties
ListSamlProvidersResponse
object
Response object for a list SAML providers request.
2 properties
1 required
DescribeSamlProviderRequest
object
Request object for a describe SAML provider request.
1 property
1 required
DescribeSamlProviderResponse
object
Response object for a describe SAML request.
1 property
1 required
UpdateSamlProviderRequest
object
Request object for an updating SAML provider request.
5 properties
1 required
UpdateSamlProviderResponse
object
Response object for an updating SAML provider request.
1 property
1 required
ListRolesRequest
object
Request object for a list roles request.
3 properties
ListRolesResponse
object
Response object for a list roles request.
2 properties
1 required
ListResourceRolesRequest
object
Request object for a list resource roles request.
3 properties
ListResourceRolesResponse
object
Response object for a list resource roles request.
2 properties
1 required
SetAccountMessagesRequest
object
Request object for set account messages for account.
1 property
SetAccountMessagesResponse
object
Response object for set account messages.
GetAccountMessagesRequest
object
Request object for get account messages.
GetAccountMessagesResponse
object
Response object for get account messages.
1 property
AssignUserRoleRequest
object
Request object for an assign user role request.
2 properties
2 required
AssignUserRoleResponse
object
Response object for an assign user role request.
UnassignUserRoleRequest
object
Request object for an unassign user role request.
2 properties
2 required
UnassignUserRoleResponse
object
Response object for an unassign user role request.
AssignUserResourceRoleRequest
object
Request object for an assign user resource role request.
3 properties
3 required
AssignUserResourceRoleResponse
object
Response object for an assign user resource role request.
UnassignUserResourceRoleRequest
object
Request object for an unassign user role request.
3 properties
3 required
UnassignUserResourceRoleResponse
object
Response object for an unassign user role request.
ListUserAssignedRolesRequest
object
Request object for a list user assigned roles request.
3 properties
ListUserAssignedRolesResponse
object
Response object for a list user assigned roles request.
2 properties
1 required
ListUserAssignedResourceRolesRequest
object
Request object for a list user assigned resource roles request.
3 properties
ListUserAssignedResourceRolesResponse
object
Response object for a list user assigned roles request.
2 properties
1 required
AssignMachineUserRoleRequest
object
Request object for an assign machine user role request.
2 properties
2 required
AssignMachineUserRoleResponse
object
Response object for an assign machine user role request.
UnassignMachineUserRoleRequest
object
Request object for an unassign machine user role request.
2 properties
2 required
UnassignMachineUserRoleResponse
object
Response object for an unassign machine user role request.
AssignMachineUserResourceRoleRequest
object
Request object for an assign machine user resource role request.
3 properties
3 required
AssignMachineUserResourceRoleResponse
object
Response object for an assign machine user resource role request.
UnassignMachineUserResourceRoleRequest
object
Request object for an unassign machine user role request.
3 properties
3 required
UnassignMachineUserResourceRoleResponse
object
Response object for an unassign machine user role request.
ListMachineUserAssignedRolesRequest
object
Request object for a list machine user assigned roles request.
3 properties
1 required
ListMachineUserAssignedRolesResponse
object
Response object for a list machine user assigned roles request.
2 properties
1 required
ListMachineUserAssignedResourceRolesRequest
object
Request object for a list machine user assigned resource roles request.
3 properties
1 required
ListMachineUserAssignedResourceRolesResponse
object
Response object for a list machine user assigned roles request.
2 properties
1 required
ListResourceAssigneesRequest
object
Request object for a list resource assignees request.
3 properties
1 required
ListResourceAssigneesResponse
object
Response object for a list resource assignees request.
2 properties
1 required
CreateMachineUserRequest
object
Request object for create machine user request.
1 property
1 required
CreateMachineUserResponse
object
Response object for create machine user request.
1 property
1 required
ListMachineUsersRequest
object
Request object for a list machine users request.
3 properties
ListMachineUsersResponse
object
Response object for a list machine users request.
2 properties
1 required
DeleteMachineUserRequest
object
Request object for delete machine user request.
1 property
1 required
DeleteMachineUserResponse
object
Response object for delete machine user request.
4 properties
4 required
CreateGroupRequest
object
Request object for create group request.
2 properties
1 required
CreateGroupResponse
object
Response object for create group request.
1 property
1 required
DeleteGroupRequest
object
Request object for delete group request.
1 property
1 required
DeleteGroupResponse
object
Response object for delete group request.
ListGroupsRequest
object
Request object for a list groups request.
3 properties
ListGroupsResponse
object
Response object for a list groups request.
2 properties
1 required
UpdateGroupRequest
object
Request object for update group request.
2 properties
1 required
UpdateGroupResponse
object
Response object for update group request.
1 property
1 required
AddUserToGroupRequest
object
Request object for an add user to group request.
2 properties
2 required
AddUserToGroupResponse
object
Response object for an add user to group request.
AddMachineUserToGroupRequest
object
Request object for an add machine user to group request.
2 properties
2 required
AddMachineUserToGroupResponse
object
Response object for add machine user to group request.
RemoveUserFromGroupRequest
object
Request object for a remove user from group request.
2 properties
2 required
RemoveUserFromGroupResponse
object
Response object for a remove user from group request.
RemoveMachineUserFromGroupRequest
object
Request object for a remove machine user from group request.
2 properties
2 required
RemoveMachineUserFromGroupResponse
object
Response object for a remove machine user from group request.
ListGroupMembersRequest
object
Request object for a list group members request.
3 properties
1 required
ListGroupMembersResponse
object
Response object for a list group members request.
2 properties
1 required
ListGroupsForUserRequest
object
Request object for a list groups for user request.
3 properties
1 required
ListGroupsForUserResponse
object
Response object for a list groups for user request.
2 properties
1 required
ListGroupsForMachineUserRequest
object
Request object for a list groups for machine user request.
3 properties
1 required
ListGroupsForMachineUserResponse
object
Response object for a list groups for machine user request.
2 properties
1 required
AssignGroupRoleRequest
object
Request object for an assign group role request.
2 properties
2 required
AssignGroupRoleResponse
object
Response object for an assign group role request.
UnassignGroupRoleRequest
object
Request object for an unassign group role request.
2 properties
2 required
UnassignGroupRoleResponse
object
Response object for an unassign group role request.
AssignGroupResourceRoleRequest
object
Request object for an assign group resource role request.
3 properties
3 required
AssignGroupResourceRoleResponse
object
Response object for an assign group resource role request.
UnassignGroupResourceRoleRequest
object
Request object for an unassign group resource role request.
3 properties
3 required
UnassignGroupResourceRoleResponse
object
Response object for an unassign group role request.
ListGroupAssignedRolesRequest
object
Request object for a list group assigned roles request.
3 properties
1 required
ListGroupAssignedRolesResponse
object
Response object for a list group assigned roles request.
2 properties
1 required
ListGroupAssignedResourceRolesRequest
object
Request object for a list group assigned resource roles request.
3 properties
1 required
ListGroupAssignedResourceRolesResponse
object
Response object for a list group assigned resource roles request.
2 properties
1 required
EnableClouderaSSOLoginRequest
object
Request object for an enable Cloudera SSO login request.
EnableClouderaSSOLoginResponse
object
Response object for an enable Cloudera SSO login request.
DisableClouderaSSOLoginRequest
object
Request object for a disable Cloudera SSO login request.
DisableClouderaSSOLoginResponse
object
Response object for a disable Cloudera SSO login request.
GetAccountRequest
object
Request object for a get account request.
GetAccountResponse
object
Response object for a get account response.
1 property
1 required
CreateUserRequest
object
Request object for creating user request.
6 properties
2 required
CreateUserResponse
object
Response object for a create user request.
1 property
1 required
UpdateUserRequest
object
Request object to update a user.
2 properties
1 required
UpdateUserResponse
object
Response object to update a user.
1 property
1 required
DeleteUserRequest
object
Request object to delete a user.
1 property
1 required
DeleteUserResponse
object
Response object to delete a user.
4 properties
4 required
SetWorkloadPasswordRequest
object
Request object for a set workload password request.
2 properties
1 required
SetWorkloadPasswordResponse
object
Response object for a set workload password request.
PasswordPolicy
object
An object representing password policy options.
8 properties
SetWorkloadPasswordPolicyRequest
object
Request object for a set workload password policy request.
2 properties
SetWorkloadPasswordPolicyResponse
object
Response object for a set workload password policy request.
UnsetWorkloadPasswordMinLifetimeRequest
object
Request object for a unset workload password min lifetime request.
1 property
1 required
UnsetWorkloadPasswordMinLifetimeResponse
object
Response object for an unset workload password minimum lifetime request.
UnsetWorkloadPasswordPolicyRequest
object
Request object for a unset workload password policy request.
2 properties
UnsetWorkloadPasswordPolicyResponse
object
Response object for a unset workload password policy request.
AddSshPublicKeyRequest
object
Request object for add user ssh public key.
3 properties
1 required
AddSshPublicKeyResponse
object
Response object for add ssh public key.
1 property
1 required
ListSshPublicKeysRequest
object
Request object for list SSH public key.
1 property
ListSshPublicKeysResponse
object
Response object for list SSH public key.
1 property
1 required
DescribeSshPublicKeyRequest
object
Request object for describe SSH public key.
2 properties
1 required
DescribeSshPublicKeyResponse
object
Response object for describe user SSH public key.
1 property
1 required
DeleteSshPublicKeyRequest
object
Request object for delete SSH public key.
2 properties
1 required
DeleteSshPublicKeyResponse
object
Response object for delete SSH public key.
UpdateLdapProviderRequest
object
Update LDAP Provider for account.
18 properties
7 required
UpdateLdapProviderResponse
object
Update LDAP provider response
1 property
1 required
CreateLdapProviderRequest
object
Create an LDAP Provider for account.
18 properties
7 required
CreateLdapProviderResponse
object
Create LDAP provider response
1 property
1 required
LdapProvider
object
LDAP Provider details.
6 properties
5 required
LdapProviderInfo
object
Information about an LDAP provider connector.
15 properties
5 required
GetDefaultIdentityProviderRequest
object
Request object to get the default identity provider.
GetDefaultIdentityProviderResponse
object
Response object to get the default identity provider.
1 property
1 required
SetDefaultIdentityProviderRequest
object
Request object to set the default identity provider.
1 property
1 required
SetDefaultIdentityProviderResponse
object
Response object to set the default identity provider.
GenerateWorkloadAuthTokenRequest
object
Request object for GenerateWorkloadAuthToken method.
3 properties
1 required
GenerateWorkloadAuthTokenResponse
object
Response object for GenerateWorkloadAuthToken method.
3 properties
WorkloadName
string
The workload name.
CreateScimAccessTokenRequest
object
Request object to create the SCIM access token.
2 properties
2 required
CreateScimAccessTokenResponse
object
Response object to create the SCIM access token.
2 properties
2 required
ListScimAccessTokensRequest
object
Request object to list the SCIM access tokens.
3 properties
1 required
ListScimAccessTokensResponse
object
Response object to list the SCIM access tokens.
2 properties
1 required
DeleteScimAccessTokenRequest
object
Request object to delete the SCIM access token.
1 property
1 required
DeleteScimAccessTokenResponse
object
Response object to delete the SCIM access token.
ScimAccessToken
object
Information about the SCIM access token.
4 properties
3 required
UnlockUserInControlPlaneRequest
object
Request object for unlocking the user in the CDP control plane.
1 property
1 required
UnlockUserInControlPlaneResponse
object
Response object for unlocking the user in the CDP control plane.
1 property
1 required
UnlockMachineUserInControlPlaneRequest
object
Request object for unlocking the machine user in the control plane.
1 property
1 required
UnlockMachineUserInControlPlaneResponse
object
Response object for unlocking the machine user in the CDP control plane.
1 property
1 required
SetSamlAuthnRequestSigningKeyRequest
object
Request object for setting the SAML AuthnRequest signing key and verification certificate.
4 properties
1 required
SetSamlAuthnRequestSigningKeyResponse
object
Response object for setting the SAML AuthnRequest signing key and verification certificate.
4 properties
4 required
MigrateUsersToIdentityProviderRequest
object
Request object for migrating users from an Identity Provider Connector to a new one.
2 properties
2 required
MigrateUsersToIdentityProviderResponse
object
Response object for migrating users from old Identity Provider Connector to a new one.
1 property
1 required
SetSamlResponseDecryptionKeyRequest
object
Request object for setting the encryption certificate and decryption key for SAML response.
4 properties
1 required
SetSamlResponseDecryptionKeyResponse
object
Response object for setting the encryption certificate and decryption key for SAML response.
4 properties
4 required
EnableUserWorkloadPasswordChangedNotificationsRequest
object
Request object to enable user workload password changed notifications.
EnableUserWorkloadPasswordChangedNotificationsResponse
object
Response object to enable user workload password changed notifications.
1 property
1 required
DisableUserWorkloadPasswordChangedNotificationsRequest
object
Request object to disable user workload password changed notifications.
DisableUserWorkloadPasswordChangedNotificationsResponse
object
Response object to disable user workload password changed notifications.
1 property
1 required
Specification
The full machine-readable OpenAPI contract behind this narrative.
Source
More from Cloudera 12
Other APIs Cloudera publishes across the network.
Cloudera Audit Service API
Cloudera Private Links API
Cloudera Compute Service API
Cloudera Consumption API
Cloudera Data Catalog API
Cloudera Data Hub API
Cloudera Datalake API
Cloudera Data Engineering API
Cloudera DataFlow API
Cloudera DataFlow Workload API
Cloudera Control Plane Data Recovery API
Cloudera Data Warehouse API
#IAM#Identity#SAML#SCIM
Where this information came from
This is an independent, third-party profile of Cloudera 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.