diff --git a/api-docs-beta/CHANGELOG.md b/api-docs-beta/CHANGELOG.md index 75294b9a1..502474c31 100644 --- a/api-docs-beta/CHANGELOG.md +++ b/api-docs-beta/CHANGELOG.md @@ -1,5 +1,11 @@ # CDP Control Plane Public API Changelog +## 0.9.128 (2024-12-11) +* iam: Add `migrateUsersToIdentityProvider` command. +* datahub: Deprecate `rotateSaltPassword` command. +* datalake: Deprecate `rotateSaltPassword` command. +* environments2: Deprecate `rotateSaltPassword` command. + ## 0.9.127 (2024-12-06) * compute: Add `resume-cluster` and `suspend-cluster` commands. * dw: Deprecate property `downloadOptions` in `CreateClusterDiagnosticDataJobRequest` object. diff --git a/api-docs-beta/README.md b/api-docs-beta/README.md index bb08455ad..f35647590 100644 --- a/api-docs-beta/README.md +++ b/api-docs-beta/README.md @@ -1,30 +1,30 @@ # CDP Control Plane Public API Documentation -*Version: 0.9.127 (BETA)* +*Version: 0.9.128 (BETA)* Available documentation is listed by service below. | Service | Version | | --- | --- | -| [audit](./audit/index.html) | 0.9.127 | -| [cloudprivatelinks](./cloudprivatelinks/index.html) | 0.9.127 | -| [compute](./compute/index.html) | 0.9.127 | -| [consumption](./consumption/index.html) | 0.9.127 | -| [datacatalog](./datacatalog/index.html) | 0.9.127 | -| [datahub](./datahub/index.html) | 0.9.127 | -| [datalake](./datalake/index.html) | 0.9.127 | -| [de](./de/index.html) | 0.9.127 | -| [df](./df/index.html) | 0.9.127 | -| [dfworkload](./dfworkload/index.html) | 0.9.127 | -| [drscp](./drscp/index.html) | 0.9.127 | -| [dw](./dw/index.html) | 0.9.127 | -| [environments](./environments/index.html) | 0.9.127 | -| [iam](./iam/index.html) | 0.9.127 | -| [imagecatalog](./imagecatalog/index.html) | 0.9.127 | -| [metrics](./metrics/index.html) | 0.9.127 | -| [ml](./ml/index.html) | 0.9.127 | -| [opdb](./opdb/index.html) | 0.9.127 | -| [replicationmanager](./replicationmanager/index.html) | 0.9.127 | +| [audit](./audit/index.html) | 0.9.128 | +| [cloudprivatelinks](./cloudprivatelinks/index.html) | 0.9.128 | +| [compute](./compute/index.html) | 0.9.128 | +| [consumption](./consumption/index.html) | 0.9.128 | +| [datacatalog](./datacatalog/index.html) | 0.9.128 | +| [datahub](./datahub/index.html) | 0.9.128 | +| [datalake](./datalake/index.html) | 0.9.128 | +| [de](./de/index.html) | 0.9.128 | +| [df](./df/index.html) | 0.9.128 | +| [dfworkload](./dfworkload/index.html) | 0.9.128 | +| [drscp](./drscp/index.html) | 0.9.128 | +| [dw](./dw/index.html) | 0.9.128 | +| [environments](./environments/index.html) | 0.9.128 | +| [iam](./iam/index.html) | 0.9.128 | +| [imagecatalog](./imagecatalog/index.html) | 0.9.128 | +| [metrics](./metrics/index.html) | 0.9.128 | +| [ml](./ml/index.html) | 0.9.128 | +| [opdb](./opdb/index.html) | 0.9.128 | +| [replicationmanager](./replicationmanager/index.html) | 0.9.128 | API documentation uses the Adoc Riak stylesheet from [https://github.com/darshandsoni/asciidoctor-skins](https://github.com/darshandsoni/asciidoctor-skins). diff --git a/api-docs-beta/audit/index.html b/api-docs-beta/audit/index.html index 687254e0c..4b79d750c 100644 --- a/api-docs-beta/audit/index.html +++ b/api-docs-beta/audit/index.html @@ -822,7 +822,7 @@

Overview

Version information

-

Version : 0.9.127 (BETA)

+

Version : 0.9.128 (BETA)

@@ -3910,7 +3910,7 @@

MarkArchiveBatchesAsSuccessfulR


diff --git a/api-docs-beta/cloudprivatelinks/index.html b/api-docs-beta/cloudprivatelinks/index.html index 5a16ca8b3..e3f11adf5 100644 --- a/api-docs-beta/cloudprivatelinks/index.html +++ b/api-docs-beta/cloudprivatelinks/index.html @@ -775,7 +775,7 @@

Overview

Version information

-

Version : 0.9.127 (BETA)

+

Version : 0.9.128 (BETA)

@@ -2782,7 +2782,7 @@

RevokePrivateLinkServiceAccessRes


diff --git a/api-docs-beta/compute/index.html b/api-docs-beta/compute/index.html index 9715a1874..3e8dd650d 100644 --- a/api-docs-beta/compute/index.html +++ b/api-docs-beta/compute/index.html @@ -942,7 +942,7 @@

Overview

Version information

-

Version : 0.9.127 (BETA)

+

Version : 0.9.128 (BETA)

@@ -10746,7 +10746,7 @@

ValidationSummary


diff --git a/api-docs-beta/consumption/index.html b/api-docs-beta/consumption/index.html index 5b9a79faa..f90fc4b56 100644 --- a/api-docs-beta/consumption/index.html +++ b/api-docs-beta/consumption/index.html @@ -720,7 +720,7 @@

Overview

Version information

-

Version : 0.9.127 (BETA)

+

Version : 0.9.128 (BETA)

@@ -1259,7 +1259,7 @@

ListComputeUsageRecordsResponse


diff --git a/api-docs-beta/datacatalog/index.html b/api-docs-beta/datacatalog/index.html index 513f7ffbf..25feda7e4 100644 --- a/api-docs-beta/datacatalog/index.html +++ b/api-docs-beta/datacatalog/index.html @@ -721,7 +721,7 @@

Overview

Version information

-

Version : 0.9.127 (BETA)

+

Version : 0.9.128 (BETA)

@@ -1220,7 +1220,7 @@

LaunchProfilersResponse


diff --git a/api-docs-beta/datahub/index.html b/api-docs-beta/datahub/index.html index 8200c67ea..c114edb99 100644 --- a/api-docs-beta/datahub/index.html +++ b/api-docs-beta/datahub/index.html @@ -1415,7 +1415,7 @@

Overview

Version information

-

Version : 0.9.127 (BETA)

+

Version : 0.9.128 (BETA)

@@ -6024,7 +6024,7 @@

Rotate SaltStack user password on Data Hub instance

Description

-

Rotate SaltStack user password on Data Hub instances.

+

Deprecated, please use rotateSecrets with SALT_PASSWORD secretType instead.

@@ -17921,7 +17921,7 @@

RotatePrivateCertificatesResponse

RotateSaltPasswordRequest

-

Request object for rotating SaltStack user password on Data Hub instances.

+

Request object for rotating SaltStack user password on Data Hub instances (Deprecated).

@@ -17955,7 +17955,7 @@

RotateSaltPasswordRequest

RotateSaltPasswordResponse

-

Response object for rotating SaltStack user password on Data Hub instances.

+

Response object for rotating SaltStack user password on Data Hub instances (Deprecated).

Type : object

@@ -19434,7 +19434,7 @@

VolumeEncryptionRequest


diff --git a/api-docs-beta/datalake/index.html b/api-docs-beta/datalake/index.html index 4f825c32b..e99d51ca1 100644 --- a/api-docs-beta/datalake/index.html +++ b/api-docs-beta/datalake/index.html @@ -1249,7 +1249,7 @@

Overview

Version information

-

Version : 0.9.127 (BETA)

+

Version : 0.9.128 (BETA)

@@ -4568,7 +4568,7 @@

Rotate SaltStack user password on DataLake instance

Description

-

Rotate SaltStack user password on DataLake instances.

+

Deprecated, please use rotateSecrets with SALT_PASSWORD secretType instead.

@@ -13379,7 +13379,7 @@

RotatePrivateCertificatesResponse

RotateSaltPasswordRequest

-

Request object for rotating SaltStack user password on DataLake instances.

+

Request object for rotating SaltStack user password on DataLake instances (Deprecated).

@@ -13413,7 +13413,7 @@

RotateSaltPasswordRequest

RotateSaltPasswordResponse

-

Response object for rotating SaltStack user password on DataLake instances.

+

Response object for rotating SaltStack user password on DataLake instances (Deprecated).

Type : object

@@ -15100,7 +15100,7 @@

ValidateAzureCloudStorageResponse
diff --git a/api-docs-beta/de/index.html b/api-docs-beta/de/index.html index 9b2ce34b7..25b0c6611 100644 --- a/api-docs-beta/de/index.html +++ b/api-docs-beta/de/index.html @@ -915,7 +915,7 @@

Overview

Version information

-

Version : 0.9.127 (BETA)

+

Version : 0.9.128 (BETA)

@@ -7494,7 +7494,7 @@

VcSummary


diff --git a/api-docs-beta/df/index.html b/api-docs-beta/df/index.html index 2a513400f..e84e069c0 100644 --- a/api-docs-beta/df/index.html +++ b/api-docs-beta/df/index.html @@ -1212,7 +1212,7 @@

Overview

Version information

-

Version : 0.9.127 (BETA)

+

Version : 0.9.128 (BETA)

@@ -14419,7 +14419,7 @@

UpgradeServiceResponse


diff --git a/api-docs-beta/dfworkload/index.html b/api-docs-beta/dfworkload/index.html index f40922482..935384e59 100644 --- a/api-docs-beta/dfworkload/index.html +++ b/api-docs-beta/dfworkload/index.html @@ -1214,7 +1214,7 @@

Overview

Version information

-

Version : 0.9.127 (BETA)

+

Version : 0.9.128 (BETA)

@@ -14359,7 +14359,7 @@

ValidateCustomPythonConfigur


diff --git a/api-docs-beta/drscp/index.html b/api-docs-beta/drscp/index.html index ff3c10094..849fd84da 100644 --- a/api-docs-beta/drscp/index.html +++ b/api-docs-beta/drscp/index.html @@ -797,7 +797,7 @@

Overview

Version information

-

Version : 0.9.127 (BETA)

+

Version : 0.9.128 (BETA)

@@ -2842,7 +2842,7 @@

SimpleRestore


diff --git a/api-docs-beta/dw/index.html b/api-docs-beta/dw/index.html index 079e58178..dc9e34ee9 100644 --- a/api-docs-beta/dw/index.html +++ b/api-docs-beta/dw/index.html @@ -1628,7 +1628,7 @@

Overview

Version information

-

Version : 0.9.127 (BETA)

+

Version : 0.9.128 (BETA)

@@ -26434,7 +26434,7 @@

VwType


diff --git a/api-docs-beta/environments/index.html b/api-docs-beta/environments/index.html index e7ff204dc..9ec9686e4 100644 --- a/api-docs-beta/environments/index.html +++ b/api-docs-beta/environments/index.html @@ -1692,7 +1692,7 @@

Overview

Version information

-

Version : 0.9.127 (BETA)

+

Version : 0.9.128 (BETA)

@@ -6731,7 +6731,7 @@

Rotate SaltStack user password on FreeIPA instances

Description

-

Rotate SaltStack user password on FreeIPA instances.

+

Deprecated, please use rotateFreeipaSecrets with SALT_PASSWORD secretType instead.

@@ -22292,7 +22292,7 @@

RotateFreeipaSecretsResponse

RotateSaltPasswordRequest

-

Request object for rotating SaltStack user password on FreeIPA instances.

+

Request object for rotating SaltStack user password on FreeIPA instances (Deprecated).

@@ -22326,7 +22326,7 @@

RotateSaltPasswordRequest

RotateSaltPasswordResponse

-

Response object for rotating SaltStack user password on FreeIPA instances.

+

Response object for rotating SaltStack user password on FreeIPA instances (Deprecated).

Type : object

@@ -26310,7 +26310,7 @@

ValidateAzureCloudStorageResponse
diff --git a/api-docs-beta/iam/index.html b/api-docs-beta/iam/index.html index 5e31da59f..15ecb3098 100644 --- a/api-docs-beta/iam/index.html +++ b/api-docs-beta/iam/index.html @@ -1075,167 +1075,174 @@

Cloudera IAM Service

  • Responses
  • -
  • Remove a machine user from a group. +
  • Migrates all users from an identity provider connector to a different identity provider connector.
  • -
  • Remove a user from a group. +
  • Remove a machine user from a group.
  • -
  • Set messages for an account. +
  • Remove a user from a group.
  • -
  • Set the authentication policy for the account. +
  • Set messages for an account.
  • -
  • Sets the default identity provider. +
  • Set the authentication policy for the account.
  • -
  • Set the workload password for an actor. +
  • Sets the default identity provider.
  • -
  • Set the workload password policy for the account. +
  • Set the workload password for an actor.
  • -
  • Unassign an Azure cloud identity from an actor or group. +
  • Set the workload password policy for the account.
  • -
  • Unassign a resource role from a group. +
  • Unassign an Azure cloud identity from an actor or group.
  • -
  • Unassign a role from a group. +
  • Unassign a resource role from a group.
  • -
  • Unassign a resource role from a machine user. +
  • Unassign a role from a group.
  • -
  • Unassign a role from a machine user. +
  • Unassign a resource role from a machine user.
  • -
  • Unassign an Azure cloud identity from a service principal. +
  • Unassign a role from a machine user.
  • -
  • Unassign a resource role from a user. +
  • Unassign an Azure cloud identity from a service principal.
  • -
  • Unassign a role from a user. +
  • Unassign a resource role from a user.
  • -
  • Unlocks machine user in the CDP control plane. +
  • Unassign a role from a user.
  • -
  • Unlocks user in the CDP control plane. +
  • Unlocks machine user in the CDP control plane.
  • -
  • Removes workload password minimum lifetime date for an actor. +
  • Unlocks user in the CDP control plane.
  • -
  • Unset workload password policy for the account. +
  • Removes workload password minimum lifetime date for an actor.
  • -
  • Updates an access key. +
  • Unset workload password policy for the account.
  • -
  • Update a group. +
  • Updates an access key.
  • -
  • Updates a SAML provider in CDP. +
  • Update a group.
  • -
  • Updates a user. +
  • Updates a SAML provider in CDP.
  • +
  • Updates a user. + +
  • Definitions @@ -1359,6 +1366,8 @@

    Cloudera IAM Service

  • ListUsersRequest
  • ListUsersResponse
  • MachineUser
  • +
  • MigrateUsersToIdentityProviderRequest
  • +
  • MigrateUsersToIdentityProviderResponse
  • PasswordPolicy
  • Policy
  • PolicyStatement
  • @@ -1435,7 +1444,7 @@

    Overview

    Version information

    -

    Version : 0.9.127 (BETA)

    +

    Version : 0.9.128 (BETA)

    @@ -6207,6 +6216,92 @@

    Responses

    +

    Migrates all users from an identity provider connector to a different identity provider connector.

    +
    +
    +
    POST /iam/migrateUsersToIdentityProvider
    +
    +
    +
    +

    Description

    +
    +

    Allow existing users to be associated with a different identity provider connector. It is required that the identity provider user ID for each user be the same in both identity providers. This is expected to be used for migration from LDAP authentication to SAML authentication for the same physical IdP. A new SAML connector would be created in CDP, integrated with the same IdP as the original LDAP connector. First the LDAP mapping would be set to use the planned SAML name id mapping. Then this method can switch users created via LDAP login to be associated with the SAML connector and enable SAML authentication instead of LDAP authentication.

    +
    +
    +
    +

    Parameters

    +
    +++++ + + + + + + + + + + + + + + +
    TypeNameSchema
    +

    Body

    +
    +

    input
    +required

    +
    +
    +
    +

    Responses

    + +++++ + + + + + + + + + + + + + + + + + + + +
    HTTP CodeDescriptionSchema
    +

    200

    +
    +

    Expected response to a valid request.

    +
    +

    default

    +
    +

    The default response on an error.

    +
    +

    Error

    +
    +
    +

    +

    Remove a machine user from a group.

    @@ -6214,13 +6309,13 @@

    Remove a machine user from a group.

    -

    Description

    +

    Description

    Remove a machine user from a group.

    -

    Parameters

    +

    Parameters

    @@ -6251,7 +6346,7 @@

    Parameters

    -

    Responses

    +

    Responses

    @@ -6300,13 +6395,13 @@

    Remove a user from a group.

    -

    Description

    +

    Description

    Remove a user from a group.

    -

    Parameters

    +

    Parameters

    @@ -6337,7 +6432,7 @@

    Parameters

    -

    Responses

    +

    Responses

    @@ -6386,13 +6481,13 @@

    Set messages for an account.

    -

    Description

    +

    Description

    Set messages for an account.

    -

    Parameters

    +

    Parameters

    @@ -6423,7 +6518,7 @@

    Parameters

    -

    Responses

    +

    Responses

    @@ -6472,13 +6567,13 @@

    Set the authentication policy for the account.
    -

    Description

    +

    Description

    Set the authentication policy for the account. Any parameters not specified in the request will be cleared, and their default values will be used for authentication. Changes to the authentication policy only affect authentications that are done after the policy has been updated.

    -

    Parameters

    +

    Parameters

    @@ -6509,7 +6604,7 @@

    Parameters

    -

    Responses

    +

    Responses

    @@ -6558,13 +6653,13 @@

    Sets the default identity provider.

    -

    Description

    +

    Description

    Sets the default identity provider used for CDP initiated login requests.

    -

    Parameters

    +

    Parameters

    @@ -6595,7 +6690,7 @@

    Parameters

    -

    Responses

    +

    Responses

    @@ -6644,13 +6739,13 @@

    Set the workload password for an actor.

    -

    Description

    +

    Description

    Set the workload password for an actor. This will be the actor’s password in all Environments they have access to, including Environments they are given access to after setting the password. The password plaintext is not kept.

    -

    Parameters

    +

    Parameters

    @@ -6681,7 +6776,7 @@

    Parameters

    -

    Responses

    +

    Responses

    @@ -6730,13 +6825,13 @@

    Set the workload password policy for the acc
    -

    Description

    +

    Description

    Set the workload password for the account. Changes to the workload password policy only affect passwords that are set after the policy has been updated. By default, passwords never expire.

    -

    Parameters

    +

    Parameters

    @@ -6767,7 +6862,7 @@

    Parameters

    -

    Responses

    +

    Responses

    @@ -6816,13 +6911,13 @@

    Unassign an Azure cloud identity from an ac
    -

    Description

    +

    Description

    Unassign an Azure cloud identity, i.e. an object ID (OID), from an actor or group.

    -

    Parameters

    +

    Parameters

    @@ -6853,7 +6948,7 @@

    Parameters

    -

    Responses

    +

    Responses

    @@ -6902,13 +6997,13 @@

    Unassign a resource role from a group.

    -

    Description

    +

    Description

    Unassign a resource role from a group. If the resource role is not currently assigned to the group the request will fail.

    -

    Parameters

    +

    Parameters

    @@ -6939,7 +7034,7 @@

    Parameters

    -

    Responses

    +

    Responses

    @@ -6988,13 +7083,13 @@

    Unassign a role from a group.

    -

    Description

    +

    Description

    Unassign a role from a group. If the role is not currently assigned to the group the request will fail.

    -

    Parameters

    +

    Parameters

    @@ -7025,7 +7120,7 @@

    Parameters

    -

    Responses

    +

    Responses

    @@ -7074,13 +7169,13 @@

    Unassign a resource role from a machin
    -

    Description

    +

    Description

    Unassign a resource role from a machine user. If the resource role is not currently assigned to the machine user the request will fail.

    -

    Parameters

    +

    Parameters

    @@ -7111,7 +7206,7 @@

    Parameters

    -

    Responses

    +

    Responses

    @@ -7160,13 +7255,13 @@

    Unassign a role from a machine user.

    -

    Description

    +

    Description

    Unassign a role from a machine user. If the role is not currently assigned to the machine user the request will fail.

    -

    Parameters

    +

    Parameters

    @@ -7197,7 +7292,7 @@

    Parameters

    -

    Responses

    +

    Responses

    @@ -7246,13 +7341,13 @@

    Unassign an Azure cloud ide
    -

    Description

    +

    Description

    Unassign an Azure cloud identity, i.e. an object ID (OID), from a service principal.

    -

    Parameters

    +

    Parameters

    @@ -7283,7 +7378,7 @@

    Parameters

    -

    Responses

    +

    Responses

    @@ -7332,13 +7427,13 @@

    Unassign a resource role from a user.

    -

    Description

    +

    Description

    Unassign a resource role from a user. If the resource role is not currently assigned to the user the request will fail.

    -

    Parameters

    +

    Parameters

    @@ -7369,7 +7464,7 @@

    Parameters

    -

    Responses

    +

    Responses

    @@ -7418,13 +7513,13 @@

    Unassign a role from a user.

    -

    Description

    +

    Description

    Unassign a role from a user. If the role is not currently assigned to the user the request will fail.

    -

    Parameters

    +

    Parameters

    @@ -7455,7 +7550,7 @@

    Parameters

    -

    Responses

    +

    Responses

    @@ -7504,13 +7599,13 @@

    Unlocks machine user in the CDP contro
    -

    Description

    +

    Description

    Unlocks machine user in the CDP control plane. This operation is idempotent. Unlocking an active machine user will succeed and leave the machine user active. This operation is only supported on Cloudera for Government.

    -

    Parameters

    +

    Parameters

    @@ -7541,7 +7636,7 @@

    Parameters

    -

    Responses

    +

    Responses

    @@ -7590,13 +7685,13 @@

    Unlocks user in the CDP control plane.

    -

    Description

    +

    Description

    Unlocks user in the CDP control plane. This operation is idempotent. Unlocking an active user will succeed and leave the user active. This operation is only supported on Cloudera for Government.

    -

    Parameters

    +

    Parameters

    @@ -7627,7 +7722,7 @@

    Parameters

    -

    Responses

    +

    Responses

    @@ -7676,13 +7771,13 @@

    Removes workload password minimum lif
    -

    Description

    +

    Description

    Removes the workload password minimum lifetime date for an actor.

    -

    Parameters

    +

    Parameters

    @@ -7713,7 +7808,7 @@

    Parameters

    -

    Responses

    +

    Responses

    @@ -7762,13 +7857,13 @@

    Unset workload password policy for the acc
    -

    Description

    +

    Description

    Unset the workload password for the account. Changes to the workload password policy only affect passwords that are set after the policy has been updated.

    -

    Parameters

    +

    Parameters

    @@ -7799,7 +7894,7 @@

    Parameters

    -

    Responses

    +

    Responses

    @@ -7848,13 +7943,13 @@

    Updates an access key.

    -

    Description

    +

    Description

    Updates an access key.

    -

    Parameters

    +

    Parameters

    @@ -7885,7 +7980,7 @@

    Parameters

    -

    Responses

    +

    Responses

    @@ -7934,13 +8029,13 @@

    Update a group.

    -

    Description

    +

    Description

    Update a group.

    -

    Parameters

    +

    Parameters

    @@ -7971,7 +8066,7 @@

    Parameters

    -

    Responses

    +

    Responses

    @@ -8020,13 +8115,13 @@

    Updates a SAML provider in CDP.

    -

    Description

    +

    Description

    Updates a SAML provider in CDP.

    -

    Parameters

    +

    Parameters

    @@ -8057,7 +8152,7 @@

    Parameters

    -

    Responses

    +

    Responses

    @@ -8106,13 +8201,13 @@

    Updates a user.

    -

    Description

    +

    Description

    Updates a user. Updates request fields provided. An error is returned if no field updates are defined in the request.

    -

    Parameters

    +

    Parameters

    @@ -8143,7 +8238,7 @@

    Parameters

    -

    Responses

    +

    Responses

    @@ -13249,6 +13344,86 @@

    MachineUser

    +

    MigrateUsersToIdentityProviderRequest

    +
    +

    Request object for migrating users from an Identity Provider Connector to a new one.

    +
    + +++++ + + + + + + + + + + + + + + + + + + + +
    NameDescriptionSchema
    +

    newProviderName
    +required

    +
    +

    The name or CRN of the new IdP provider to migrate to.

    +
    +

    string

    +
    +

    originalProviderName
    +required

    +
    +

    The name or CRN of the original IdP provider to migrate from.

    +
    +

    string

    +
    +
    +
    +

    MigrateUsersToIdentityProviderResponse

    +
    +

    Response object for migrating users from old Identity Provider Connector to a new one.

    +
    + +++++ + + + + + + + + + + + + + + +
    NameDescriptionSchema
    +

    numberOfUpdatedUsers
    +required

    +
    +

    The number of users that were migrated from the old IdP to the new one.

    +
    +

    integer (int32)

    +
    +
    +

    PasswordPolicy

    An object representing password policy options.

    @@ -15812,7 +15987,7 @@

    WorkloadPasswordPolicy


    diff --git a/api-docs-beta/imagecatalog/index.html b/api-docs-beta/imagecatalog/index.html index 957c013a9..e8126f1c0 100644 --- a/api-docs-beta/imagecatalog/index.html +++ b/api-docs-beta/imagecatalog/index.html @@ -853,7 +853,7 @@

    Overview

    Version information

    -

    Version : 0.9.127 (BETA)

    +

    Version : 0.9.128 (BETA)

    @@ -3915,7 +3915,7 @@

    VmImageType


    diff --git a/api-docs-beta/metrics/index.html b/api-docs-beta/metrics/index.html index 0273e8d0a..5ad81491d 100644 --- a/api-docs-beta/metrics/index.html +++ b/api-docs-beta/metrics/index.html @@ -775,7 +775,7 @@

    Overview

    Version information

    -

    Version : 0.9.127 (BETA)

    +

    Version : 0.9.128 (BETA)

    @@ -2755,7 +2755,7 @@

    UpdateRemoteWriteConfigResponse


    diff --git a/api-docs-beta/ml/index.html b/api-docs-beta/ml/index.html index 89675f18a..4bf4b2920 100644 --- a/api-docs-beta/ml/index.html +++ b/api-docs-beta/ml/index.html @@ -1182,7 +1182,7 @@

    Overview

    Version information

    -

    Version : 0.9.127 (BETA)

    +

    Version : 0.9.128 (BETA)

    @@ -12590,7 +12590,7 @@

    WorkspaceSummary


    diff --git a/api-docs-beta/opdb/index.html b/api-docs-beta/opdb/index.html index f6afe39b3..25ef56ba5 100644 --- a/api-docs-beta/opdb/index.html +++ b/api-docs-beta/opdb/index.html @@ -1030,7 +1030,7 @@

    Overview

    Version information

    -

    Version : 0.9.127 (BETA)

    +

    Version : 0.9.128 (BETA)

    @@ -10254,7 +10254,7 @@

    VolumeType


    diff --git a/api-docs-beta/replicationmanager/index.html b/api-docs-beta/replicationmanager/index.html index 12679e76b..d6757ef53 100644 --- a/api-docs-beta/replicationmanager/index.html +++ b/api-docs-beta/replicationmanager/index.html @@ -1254,7 +1254,7 @@

    Overview

    Version information

    -

    Version : 0.9.127 (BETA)

    +

    Version : 0.9.128 (BETA)

    @@ -17144,7 +17144,7 @@

    VerifyHbaseClusterPairResponse


    diff --git a/api-docs-beta/swagger/README.md b/api-docs-beta/swagger/README.md index 5ab63ac15..9f7ebe240 100644 --- a/api-docs-beta/swagger/README.md +++ b/api-docs-beta/swagger/README.md @@ -1,6 +1,6 @@ # CDP Control Plane Public API Swagger Service Definitions -*Version: 0.9.127 (BETA)* +*Version: 0.9.128 (BETA)* These service definitions files are the basis for official CDP API artifacts, and you can use them to create your own client-side code. They adhere to the @@ -15,25 +15,25 @@ API requests must be signed according to the | Service Definition | Version | | --- | --- | -| [audit.yaml](./audit.yaml) | 0.9.127 | -| [cloudprivatelinks.yaml](./cloudprivatelinks.yaml) | 0.9.127 | -| [compute.yaml](./compute.yaml) | 0.9.127 | -| [consumption.yaml](./consumption.yaml) | 0.9.127 | -| [datacatalog.yaml](./datacatalog.yaml) | 0.9.127 | -| [datahub.yaml](./datahub.yaml) | 0.9.127 | -| [datalake.yaml](./datalake.yaml) | 0.9.127 | -| [de.yaml](./de.yaml) | 0.9.127 | -| [df.yaml](./df.yaml) | 0.9.127 | -| [dfworkload.yaml](./dfworkload.yaml) | 0.9.127 | -| [drscp.yaml](./drscp.yaml) | 0.9.127 | -| [dw.yaml](./dw.yaml) | 0.9.127 | -| [environments.yaml](./environments.yaml) | 0.9.127 | -| [iam.yaml](./iam.yaml) | 0.9.127 | -| [imagecatalog.yaml](./imagecatalog.yaml) | 0.9.127 | -| [metrics.yaml](./metrics.yaml) | 0.9.127 | -| [ml.yaml](./ml.yaml) | 0.9.127 | -| [opdb.yaml](./opdb.yaml) | 0.9.127 | -| [replicationmanager.yaml](./replicationmanager.yaml) | 0.9.127 | +| [audit.yaml](./audit.yaml) | 0.9.128 | +| [cloudprivatelinks.yaml](./cloudprivatelinks.yaml) | 0.9.128 | +| [compute.yaml](./compute.yaml) | 0.9.128 | +| [consumption.yaml](./consumption.yaml) | 0.9.128 | +| [datacatalog.yaml](./datacatalog.yaml) | 0.9.128 | +| [datahub.yaml](./datahub.yaml) | 0.9.128 | +| [datalake.yaml](./datalake.yaml) | 0.9.128 | +| [de.yaml](./de.yaml) | 0.9.128 | +| [df.yaml](./df.yaml) | 0.9.128 | +| [dfworkload.yaml](./dfworkload.yaml) | 0.9.128 | +| [drscp.yaml](./drscp.yaml) | 0.9.128 | +| [dw.yaml](./dw.yaml) | 0.9.128 | +| [environments.yaml](./environments.yaml) | 0.9.128 | +| [iam.yaml](./iam.yaml) | 0.9.128 | +| [imagecatalog.yaml](./imagecatalog.yaml) | 0.9.128 | +| [metrics.yaml](./metrics.yaml) | 0.9.128 | +| [ml.yaml](./ml.yaml) | 0.9.128 | +| [opdb.yaml](./opdb.yaml) | 0.9.128 | +| [replicationmanager.yaml](./replicationmanager.yaml) | 0.9.128 | See all the files at once in this site's [Github repository](https://github.com/cloudera/cdp-dev-docs/tree/master/api-docs/swagger). diff --git a/api-docs-beta/swagger/audit.yaml b/api-docs-beta/swagger/audit.yaml index 157565508..fb519370c 100644 --- a/api-docs-beta/swagger/audit.yaml +++ b/api-docs-beta/swagger/audit.yaml @@ -5,7 +5,7 @@ x-products: CDP x-form-factors: public x-cdp-releases: PUBLIC info: - version: 0.9.127 (BETA) + version: 0.9.128 (BETA) title: Cloudera Audit Service license: name: Apache 2.0 diff --git a/api-docs-beta/swagger/cloudprivatelinks.yaml b/api-docs-beta/swagger/cloudprivatelinks.yaml index fc4418df0..db55c87e7 100644 --- a/api-docs-beta/swagger/cloudprivatelinks.yaml +++ b/api-docs-beta/swagger/cloudprivatelinks.yaml @@ -5,7 +5,7 @@ x-products: CDP x-form-factors: public x-cdp-releases: PUBLIC info: - version: 0.9.127 (BETA) + version: 0.9.128 (BETA) title: Cloudera CloudPrivateLinks API Service license: name: Apache 2.0 diff --git a/api-docs-beta/swagger/compute.yaml b/api-docs-beta/swagger/compute.yaml index 55b31d804..3682241d4 100644 --- a/api-docs-beta/swagger/compute.yaml +++ b/api-docs-beta/swagger/compute.yaml @@ -5,7 +5,7 @@ x-products: CDP x-form-factors: public,private x-cdp-releases: PUBLIC info: - version: 0.9.127 (BETA) + version: 0.9.128 (BETA) title: Cloudera Compute Service license: name: Apache 2.0 diff --git a/api-docs-beta/swagger/consumption.yaml b/api-docs-beta/swagger/consumption.yaml index 9821d8b7a..4f4f087ad 100644 --- a/api-docs-beta/swagger/consumption.yaml +++ b/api-docs-beta/swagger/consumption.yaml @@ -5,7 +5,7 @@ x-products: CDP x-form-factors: public x-cdp-releases: PUBLIC info: - version: 0.9.127 (BETA) + version: 0.9.128 (BETA) title: Cloudera Consumption API Service license: name: Apache 2.0 diff --git a/api-docs-beta/swagger/datacatalog.yaml b/api-docs-beta/swagger/datacatalog.yaml index 63963551f..482cda866 100644 --- a/api-docs-beta/swagger/datacatalog.yaml +++ b/api-docs-beta/swagger/datacatalog.yaml @@ -5,7 +5,7 @@ x-form-factors: public x-cdp-releases: PUBLIC x-audit: true info: - version: 0.9.127 (BETA) + version: 0.9.128 (BETA) title: Cloudera DataCatalog Service license: name: Apache 2.0 diff --git a/api-docs-beta/swagger/datahub.yaml b/api-docs-beta/swagger/datahub.yaml index a61cd7883..294845d9c 100644 --- a/api-docs-beta/swagger/datahub.yaml +++ b/api-docs-beta/swagger/datahub.yaml @@ -6,7 +6,7 @@ x-form-factors: public x-cdp-releases: PUBLIC x-audit: true info: - version: 0.9.127 (BETA) + version: 0.9.128 (BETA) title: Cloudera Data hub Service license: name: Apache 2.0 @@ -1416,10 +1416,10 @@ paths: /api/v1/datahub/rotateSaltPassword: post: summary: Rotate SaltStack user password on Data Hub instances. - description: Rotate SaltStack user password on Data Hub instances. + description: Deprecated, please use rotateSecrets with SALT_PASSWORD secretType instead. operationId: rotateSaltPassword x-mutating: true - x-entitlement: CDP_ROTATE_SALTUSER_PASSWORD + x-deprecated: true parameters: - name: input in: body @@ -4966,7 +4966,8 @@ definitions: description: Response object to a stop instances of a host group on a Data Hub. RotateSaltPasswordRequest: type: object - description: Request object for rotating SaltStack user password on Data Hub instances. + description: Request object for rotating SaltStack user password on Data Hub instances (Deprecated). + x-deprecated: true required: - cluster properties: @@ -4975,7 +4976,8 @@ definitions: description: The name or CRN of the cluster. RotateSaltPasswordResponse: type: object - description: Response object for rotating SaltStack user password on Data Hub instances. + description: Response object for rotating SaltStack user password on Data Hub instances (Deprecated). + x-deprecated: true UpdateOrchestratorStateRequest: type: object description: Request object for running orchestrator engine state update on the Data Hub cluster. diff --git a/api-docs-beta/swagger/datalake.yaml b/api-docs-beta/swagger/datalake.yaml index 45db138ff..90ac42d90 100644 --- a/api-docs-beta/swagger/datalake.yaml +++ b/api-docs-beta/swagger/datalake.yaml @@ -6,7 +6,7 @@ x-form-factors: public x-cdp-releases: PUBLIC x-audit: true info: - version: 0.9.127 (BETA) + version: 0.9.128 (BETA) title: Cloudera Datalake Service license: name: Apache 2.0 @@ -1056,10 +1056,10 @@ paths: /api/v1/datalake/rotateSaltPassword: post: summary: Rotate SaltStack user password on DataLake instances. - description: Rotate SaltStack user password on DataLake instances. + description: Deprecated, please use rotateSecrets with SALT_PASSWORD secretType instead. operationId: rotateSaltPassword x-mutating: true - x-entitlement: CDP_ROTATE_SALTUSER_PASSWORD + x-deprecated: true parameters: - name: input in: body @@ -3739,7 +3739,8 @@ definitions: description: Cloud provider instance type to create instances with. RotateSaltPasswordRequest: type: object - description: Request object for rotating SaltStack user password on DataLake instances. + description: Request object for rotating SaltStack user password on DataLake instances (Deprecated). + x-deprecated: true required: - datalake properties: @@ -3748,7 +3749,8 @@ definitions: description: The name or CRN of the datalake. RotateSaltPasswordResponse: type: object - description: Response object for rotating SaltStack user password on DataLake instances. + description: Response object for rotating SaltStack user password on DataLake instances (Deprecated). + x-deprecated: true UpdateOrchestratorStateRequest: type: object description: Request object for running orchestrator engine state update on the Data Lake cluster. diff --git a/api-docs-beta/swagger/de.yaml b/api-docs-beta/swagger/de.yaml index 714741a1d..ac7383aa8 100644 --- a/api-docs-beta/swagger/de.yaml +++ b/api-docs-beta/swagger/de.yaml @@ -5,7 +5,7 @@ x-form-factors: public,private x-cdp-releases: PUBLIC x-audit: true info: - version: 0.9.127 (BETA) + version: 0.9.128 (BETA) title: Cloudera Data Engineering license: name: Apache 2.0 diff --git a/api-docs-beta/swagger/df.yaml b/api-docs-beta/swagger/df.yaml index 2107248da..0b0886049 100644 --- a/api-docs-beta/swagger/df.yaml +++ b/api-docs-beta/swagger/df.yaml @@ -5,7 +5,7 @@ x-products: CDP x-form-factors: public x-cdp-releases: PUBLIC info: - version: 0.9.127 (BETA) + version: 0.9.128 (BETA) title: Cloudera DataFlow Service license: name: Apache 2.0 diff --git a/api-docs-beta/swagger/dfworkload.yaml b/api-docs-beta/swagger/dfworkload.yaml index b4f734a28..cf6302fa8 100644 --- a/api-docs-beta/swagger/dfworkload.yaml +++ b/api-docs-beta/swagger/dfworkload.yaml @@ -6,7 +6,7 @@ x-form-factors: public x-cdp-releases: PUBLIC info: description: "This REST API provides remote access to the DataFlow Service.\n Endpoints that are marked as [BETA] are subject to change in future releases of the application without backwards compatibility and without a major version change." - version: 0.9.127 (BETA) + version: 0.9.128 (BETA) title: Cloudera DataFlow Workload Service license: name: Apache 2.0 diff --git a/api-docs-beta/swagger/drscp.yaml b/api-docs-beta/swagger/drscp.yaml index 1d7c40b45..356c83b90 100644 --- a/api-docs-beta/swagger/drscp.yaml +++ b/api-docs-beta/swagger/drscp.yaml @@ -5,7 +5,7 @@ x-form-factors: private x-audit: true x-cdp-releases: PUBLIC info: - version: 0.9.127 (BETA) + version: 0.9.128 (BETA) title: CDP Control Plane Data Recovery Service license: name: Apache 2.0 diff --git a/api-docs-beta/swagger/dw.yaml b/api-docs-beta/swagger/dw.yaml index 876586fee..a3bfd61b3 100644 --- a/api-docs-beta/swagger/dw.yaml +++ b/api-docs-beta/swagger/dw.yaml @@ -4,7 +4,7 @@ x-products: CDP x-form-factors: public,private x-cdp-releases: PUBLIC info: - version: 0.9.127 (BETA) + version: 0.9.128 (BETA) title: Cloudera Data Warehouse [EXPERIMENTAL] license: name: Apache 2.0 diff --git a/api-docs-beta/swagger/environments.yaml b/api-docs-beta/swagger/environments.yaml index 2b3efe152..dcc8b17d1 100644 --- a/api-docs-beta/swagger/environments.yaml +++ b/api-docs-beta/swagger/environments.yaml @@ -6,7 +6,7 @@ x-form-factors: public,private x-cdp-releases: PUBLIC x-audit: true info: - version: 0.9.127 (BETA) + version: 0.9.128 (BETA) title: Cloudera Environments Service license: name: Apache 2.0 @@ -1864,10 +1864,10 @@ paths: /api/v1/environments2/rotateSaltPassword: post: summary: Rotate SaltStack user password on FreeIPA instances. - description: Rotate SaltStack user password on FreeIPA instances. + description: Deprecated, please use rotateFreeipaSecrets with SALT_PASSWORD secretType instead. operationId: rotateSaltPassword x-mutating: true - x-entitlement: CDP_ROTATE_SALTUSER_PASSWORD + x-deprecated: true parameters: - name: input in: body @@ -6461,7 +6461,8 @@ definitions: x-no-compatibility-guarantee: true RotateSaltPasswordRequest: type: object - description: Request object for rotating SaltStack user password on FreeIPA instances. + description: Request object for rotating SaltStack user password on FreeIPA instances (Deprecated). + x-deprecated: true required: - environment properties: @@ -6470,7 +6471,8 @@ definitions: description: The name or CRN of the environment. RotateSaltPasswordResponse: type: object - description: Response object for rotating SaltStack user password on FreeIPA instances. + description: Response object for rotating SaltStack user password on FreeIPA instances (Deprecated). + x-deprecated: true RotateFreeipaSecretsRequest: type: object description: Request object for starting secret rotation for FreeIPA. diff --git a/api-docs-beta/swagger/iam.yaml b/api-docs-beta/swagger/iam.yaml index 08b2aec98..edf12f0e1 100644 --- a/api-docs-beta/swagger/iam.yaml +++ b/api-docs-beta/swagger/iam.yaml @@ -7,7 +7,7 @@ x-cdp-releases: PUBLIC x-audit: true x-extensions: pvcapipath info: - version: 0.9.127 (BETA) + version: 0.9.128 (BETA) title: Cloudera IAM Service license: name: Apache 2.0 @@ -1815,6 +1815,29 @@ paths: description: The default response on an error. schema: $ref: '#/definitions/Error' + /iam/migrateUsersToIdentityProvider: + post: + summary: Migrates all users from an identity provider connector to a different identity provider connector. + description: Allow existing users to be associated with a different identity provider connector. It is required that the identity provider user ID for each user be the same in both identity providers. This is expected to be used for migration from LDAP authentication to SAML authentication for the same physical IdP. A new SAML connector would be created in CDP, integrated with the same IdP as the original LDAP connector. First the LDAP mapping would be set to use the planned SAML name id mapping. Then this method can switch users created via LDAP login to be associated with the SAML connector and enable SAML authentication instead of LDAP authentication. + operationId: migrateUsersToIdentityProvider + x-form-factors: private + x-right: iam/migrateUsersToIdentityProvider + x-mutating: true + parameters: + - name: input + in: body + required: true + schema: + $ref: '#/definitions/MigrateUsersToIdentityProviderRequest' + responses: + 200: + description: Expected response to a valid request. + schema: + $ref: '#/definitions/MigrateUsersToIdentityProviderResponse' + default: + description: The default response on an error. + schema: + $ref: '#/definitions/Error' definitions: Error: type: object @@ -4180,3 +4203,28 @@ definitions: machineUser: $ref: '#/definitions/MachineUser' description: The unlocked machine user. + MigrateUsersToIdentityProviderRequest: + type: object + description: Request object for migrating users from an Identity Provider Connector to a new one. + x-form-factor: private + required: + - originalProviderName + - newProviderName + properties: + originalProviderName: + type: string + description: The name or CRN of the original IdP provider to migrate from. + newProviderName: + type: string + description: The name or CRN of the new IdP provider to migrate to. + MigrateUsersToIdentityProviderResponse: + type: object + description: Response object for migrating users from old Identity Provider Connector to a new one. + x-form-factor: private + required: + - numberOfUpdatedUsers + properties: + numberOfUpdatedUsers: + type: integer + format: int32 + description: The number of users that were migrated from the old IdP to the new one. diff --git a/api-docs-beta/swagger/imagecatalog.yaml b/api-docs-beta/swagger/imagecatalog.yaml index 8ee6b16b7..79d597f35 100644 --- a/api-docs-beta/swagger/imagecatalog.yaml +++ b/api-docs-beta/swagger/imagecatalog.yaml @@ -5,7 +5,7 @@ x-products: CDP x-form-factors: public x-cdp-releases: PUBLIC info: - version: 0.9.127 (BETA) + version: 0.9.128 (BETA) title: Image catalog service license: name: Apache 2.0 diff --git a/api-docs-beta/swagger/metrics.yaml b/api-docs-beta/swagger/metrics.yaml index 1417b97f0..7161437d9 100644 --- a/api-docs-beta/swagger/metrics.yaml +++ b/api-docs-beta/swagger/metrics.yaml @@ -14,7 +14,7 @@ info: license: name: Apache 2.0 title: Cloudera Control Plane Monitoring Metrics Administration - version: 0.9.127 (BETA) + version: 0.9.128 (BETA) x-audit: true paths: /api/v1/metrics/createRemoteWriteConfig: diff --git a/api-docs-beta/swagger/ml.yaml b/api-docs-beta/swagger/ml.yaml index f4ba22e36..1588b8790 100644 --- a/api-docs-beta/swagger/ml.yaml +++ b/api-docs-beta/swagger/ml.yaml @@ -5,7 +5,7 @@ x-products: CDP x-form-factors: public,private x-cdp-releases: PUBLIC info: - version: 0.9.127 (BETA) + version: 0.9.128 (BETA) title: Cloudera AI license: name: Apache 2.0 diff --git a/api-docs-beta/swagger/opdb.yaml b/api-docs-beta/swagger/opdb.yaml index f8bf35dc3..16280a849 100644 --- a/api-docs-beta/swagger/opdb.yaml +++ b/api-docs-beta/swagger/opdb.yaml @@ -5,7 +5,7 @@ x-products: CDP x-form-factors: public x-cdp-releases: PUBLIC info: - version: 0.9.127 (BETA) + version: 0.9.128 (BETA) title: Operational Database service license: name: Apache 2.0 diff --git a/api-docs-beta/swagger/replicationmanager.yaml b/api-docs-beta/swagger/replicationmanager.yaml index 60b34d351..6d54d35a1 100644 --- a/api-docs-beta/swagger/replicationmanager.yaml +++ b/api-docs-beta/swagger/replicationmanager.yaml @@ -5,7 +5,7 @@ x-form-factors: public x-cdp-releases: PUBLIC x-audit: true info: - version: 0.9.127 (BETA) + version: 0.9.128 (BETA) title: Cloudera Replication Manager Service license: name: Apache 2.0