Package com.ibm.cloud.platform_services.iam_identity.v1

Class IamIdentity

  • public class IamIdentity
extends com.ibm.cloud.sdk.core.service.BaseService
    The IAM Identity Service API allows for the management of Account Settings and Identities (Service IDs, ApiKeys). API Version: 1.0.0

    • Field Detail

      • DEFAULT_SERVICE_NAME

        public static final java.lang.String DEFAULT_SERVICE_NAME
        Default service name used when configuring the `IamIdentity` client.
        See Also:
        Constant Field Values

      • DEFAULT_SERVICE_URL

        public static final java.lang.String DEFAULT_SERVICE_URL
        Default service endpoint URL.
        See Also:
        Constant Field Values

    • Constructor Detail

      • IamIdentity

        public IamIdentity​(java.lang.String serviceName,
                   com.ibm.cloud.sdk.core.security.Authenticator authenticator)
        Constructs an instance of the `IamIdentity` client. The specified service name and authenticator are used to configure the client instance.
        Parameters:
        serviceName - the service name to be used when configuring the client instance
        authenticator - the Authenticator instance to be configured for this client

    • Method Detail

      • newInstance

        public static IamIdentity newInstance()
        Class method which constructs an instance of the `IamIdentity` client. The default service name is used to configure the client instance.
        Returns:
        an instance of the `IamIdentity` client using external configuration

      • newInstance

        public static IamIdentity newInstance​(java.lang.String serviceName)
        Class method which constructs an instance of the `IamIdentity` client. The specified service name is used to configure the client instance.
        Parameters:
        serviceName - the service name to be used when configuring the client instance
        Returns:
        an instance of the `IamIdentity` client using external configuration

      • listServiceIds

        public com.ibm.cloud.sdk.core.http.ServiceCall<ServiceIdList> listServiceIds​(ListServiceIdsOptions listServiceIdsOptions)
        List service IDs. Returns a list of service IDs. Users can manage user API keys for themself, or service ID API keys for service IDs they have access to. Note: apikey details are only included in the response when creating a Service ID with an api key.
        Parameters:
        listServiceIdsOptions - the ListServiceIdsOptions containing the options for the call
        Returns:
        a ServiceCall with a result of type ServiceIdList

      • listServiceIds

        public com.ibm.cloud.sdk.core.http.ServiceCall<ServiceIdList> listServiceIds()
        List service IDs. Returns a list of service IDs. Users can manage user API keys for themself, or service ID API keys for service IDs they have access to. Note: apikey details are only included in the response when creating a Service ID with an api key.
        Returns:
        a ServiceCall with a result of type ServiceIdList

      • createServiceId

        public com.ibm.cloud.sdk.core.http.ServiceCall<ServiceId> createServiceId​(CreateServiceIdOptions createServiceIdOptions)
        Create a service ID. Creates a service ID for an IBM Cloud account. Users can manage user API keys for themself, or service ID API keys for service IDs they have access to.
        Parameters:
        createServiceIdOptions - the CreateServiceIdOptions containing the options for the call
        Returns:
        a ServiceCall with a result of type ServiceId

      • getServiceId

        public com.ibm.cloud.sdk.core.http.ServiceCall<ServiceId> getServiceId​(GetServiceIdOptions getServiceIdOptions)
        Get details of a service ID. Returns the details of a service ID. Users can manage user API keys for themself, or service ID API keys for service IDs they have access to. Note: apikey details are only included in the response when creating a Service ID with an api key.
        Parameters:
        getServiceIdOptions - the GetServiceIdOptions containing the options for the call
        Returns:
        a ServiceCall with a result of type ServiceId

      • updateServiceId

        public com.ibm.cloud.sdk.core.http.ServiceCall<ServiceId> updateServiceId​(UpdateServiceIdOptions updateServiceIdOptions)
        Update service ID. Updates properties of a service ID. This does NOT affect existing access tokens. Their token content will stay unchanged until the access token is refreshed. To update a service ID, pass the property to be modified. To delete one property's value, pass the property with an empty value "".Users can manage user API keys for themself, or service ID API keys for service IDs they have access to. Note: apikey details are only included in the response when creating a Service ID with an apikey.
        Parameters:
        updateServiceIdOptions - the UpdateServiceIdOptions containing the options for the call
        Returns:
        a ServiceCall with a result of type ServiceId

      • deleteServiceId

        public com.ibm.cloud.sdk.core.http.ServiceCall<java.lang.Void> deleteServiceId​(DeleteServiceIdOptions deleteServiceIdOptions)
        Deletes a service ID and associated API keys. Deletes a service ID and all API keys associated to it. Before deleting the service ID, all associated API keys are deleted. In case a Delete Conflict (status code 409) a retry of the request may help as the service ID is only deleted if the associated API keys were successfully deleted before. Users can manage user API keys for themself, or service ID API keys for service IDs they have access to.
        Parameters:
        deleteServiceIdOptions - the DeleteServiceIdOptions containing the options for the call
        Returns:
        a ServiceCall with a void result

      • lockServiceId

        public com.ibm.cloud.sdk.core.http.ServiceCall<java.lang.Void> lockServiceId​(LockServiceIdOptions lockServiceIdOptions)
        Lock the service ID. Locks a service ID by ID. Users can manage user API keys for themself, or service ID API keys for service IDs they have access to.
        Parameters:
        lockServiceIdOptions - the LockServiceIdOptions containing the options for the call
        Returns:
        a ServiceCall with a void result

      • unlockServiceId

        public com.ibm.cloud.sdk.core.http.ServiceCall<java.lang.Void> unlockServiceId​(UnlockServiceIdOptions unlockServiceIdOptions)
        Unlock the service ID. Unlocks a service ID by ID. Users can manage user API keys for themself, or service ID API keys for service IDs they have access to.
        Parameters:
        unlockServiceIdOptions - the UnlockServiceIdOptions containing the options for the call
        Returns:
        a ServiceCall with a void result

      • listServiceIdGroup

        public com.ibm.cloud.sdk.core.http.ServiceCall<ServiceIdGroupList> listServiceIdGroup()
        List service ID groups. Returns a list of all service ID groups for the given account ID.
        Returns:
        a ServiceCall with a result of type ServiceIdGroupList

      • createServiceIdGroup

        public com.ibm.cloud.sdk.core.http.ServiceCall<ServiceIdGroup> createServiceIdGroup​(CreateServiceIdGroupOptions createServiceIdGroupOptions)
        Create a service ID group. Creates a service ID group for the given account ID.
        Parameters:
        createServiceIdGroupOptions - the CreateServiceIdGroupOptions containing the options for the call
        Returns:
        a ServiceCall with a result of type ServiceIdGroup

      • getServiceIdGroup

        public com.ibm.cloud.sdk.core.http.ServiceCall<ServiceIdGroup> getServiceIdGroup​(GetServiceIdGroupOptions getServiceIdGroupOptions)
        Get details of a service ID group. Returns the details of a service ID group.
        Parameters:
        getServiceIdGroupOptions - the GetServiceIdGroupOptions containing the options for the call
        Returns:
        a ServiceCall with a result of type ServiceIdGroup

      • deleteServiceIdGroup

        public com.ibm.cloud.sdk.core.http.ServiceCall<java.lang.Void> deleteServiceIdGroup​(DeleteServiceIdGroupOptions deleteServiceIdGroupOptions)
        Delete a service ID group. Delete a service ID group.
        Parameters:
        deleteServiceIdGroupOptions - the DeleteServiceIdGroupOptions containing the options for the call
        Returns:
        a ServiceCall with a void result

      • listApiKeys

        public com.ibm.cloud.sdk.core.http.ServiceCall<ApiKeyList> listApiKeys​(ListApiKeysOptions listApiKeysOptions)
        Get API keys for a given service or user IAM ID and account ID. Returns the list of API key details for a given service or user IAM ID and account ID. Users can manage user API keys for themself, or service ID API keys for service IDs they have access to.
        Parameters:
        listApiKeysOptions - the ListApiKeysOptions containing the options for the call
        Returns:
        a ServiceCall with a result of type ApiKeyList

      • listApiKeys

        public com.ibm.cloud.sdk.core.http.ServiceCall<ApiKeyList> listApiKeys()
        Get API keys for a given service or user IAM ID and account ID. Returns the list of API key details for a given service or user IAM ID and account ID. Users can manage user API keys for themself, or service ID API keys for service IDs they have access to.
        Returns:
        a ServiceCall with a result of type ApiKeyList

      • createApiKey

        public com.ibm.cloud.sdk.core.http.ServiceCall<ApiKey> createApiKey​(CreateApiKeyOptions createApiKeyOptions)
        Create an API key. Creates an API key for a UserID or service ID. Users can manage user API keys for themself, or service ID API keys for service IDs they have access to.
        Parameters:
        createApiKeyOptions - the CreateApiKeyOptions containing the options for the call
        Returns:
        a ServiceCall with a result of type ApiKey

      • getApiKeysDetails

        public com.ibm.cloud.sdk.core.http.ServiceCall<ApiKey> getApiKeysDetails​(GetApiKeysDetailsOptions getApiKeysDetailsOptions)
        Get details of an API key by its value. Returns the details of an API key by its value. Users can manage user API keys for themself, or service ID API keys for service IDs they have access to.
        Parameters:
        getApiKeysDetailsOptions - the GetApiKeysDetailsOptions containing the options for the call
        Returns:
        a ServiceCall with a result of type ApiKey

      • getApiKeysDetails

        public com.ibm.cloud.sdk.core.http.ServiceCall<ApiKey> getApiKeysDetails()
        Get details of an API key by its value. Returns the details of an API key by its value. Users can manage user API keys for themself, or service ID API keys for service IDs they have access to.
        Returns:
        a ServiceCall with a result of type ApiKey

      • getApiKey

        public com.ibm.cloud.sdk.core.http.ServiceCall<ApiKey> getApiKey​(GetApiKeyOptions getApiKeyOptions)
        Get details of an API key. Returns the details of an API key. Users can manage user API keys for themself, or service ID API keys for service IDs they have access to.
        Parameters:
        getApiKeyOptions - the GetApiKeyOptions containing the options for the call
        Returns:
        a ServiceCall with a result of type ApiKey

      • updateApiKey

        public com.ibm.cloud.sdk.core.http.ServiceCall<ApiKey> updateApiKey​(UpdateApiKeyOptions updateApiKeyOptions)
        Updates an API key. Updates properties of an API key. This does NOT affect existing access tokens. Their token content will stay unchanged until the access token is refreshed. To update an API key, pass the property to be modified. To delete one property's value, pass the property with an empty value "". Users can manage user API keys for themself, or service ID API keys for service IDs they have access to.
        Parameters:
        updateApiKeyOptions - the UpdateApiKeyOptions containing the options for the call
        Returns:
        a ServiceCall with a result of type ApiKey

      • deleteApiKey

        public com.ibm.cloud.sdk.core.http.ServiceCall<java.lang.Void> deleteApiKey​(DeleteApiKeyOptions deleteApiKeyOptions)
        Deletes an API key. Deletes an API key. Existing tokens will remain valid until expired. Users can manage user API keys for themself, or service ID API keys for service IDs they have access to.
        Parameters:
        deleteApiKeyOptions - the DeleteApiKeyOptions containing the options for the call
        Returns:
        a ServiceCall with a void result

      • lockApiKey

        public com.ibm.cloud.sdk.core.http.ServiceCall<java.lang.Void> lockApiKey​(LockApiKeyOptions lockApiKeyOptions)
        Lock the API key. Locks an API key by ID. Users can manage user API keys for themself, or service ID API keys for service IDs they have access to.
        Parameters:
        lockApiKeyOptions - the LockApiKeyOptions containing the options for the call
        Returns:
        a ServiceCall with a void result

      • unlockApiKey

        public com.ibm.cloud.sdk.core.http.ServiceCall<java.lang.Void> unlockApiKey​(UnlockApiKeyOptions unlockApiKeyOptions)
        Unlock the API key. Unlocks an API key by ID. Users can manage user API keys for themself, or service ID API keys for service IDs they have access to.
        Parameters:
        unlockApiKeyOptions - the UnlockApiKeyOptions containing the options for the call
        Returns:
        a ServiceCall with a void result

      • disableApiKey

        public com.ibm.cloud.sdk.core.http.ServiceCall<java.lang.Void> disableApiKey​(DisableApiKeyOptions disableApiKeyOptions)
        Disable the API key. Disable an API key. Users can manage user API keys for themself, or service ID API keys for service IDs they have access to.
        Parameters:
        disableApiKeyOptions - the DisableApiKeyOptions containing the options for the call
        Returns:
        a ServiceCall with a void result

      • enableApiKey

        public com.ibm.cloud.sdk.core.http.ServiceCall<java.lang.Void> enableApiKey​(EnableApiKeyOptions enableApiKeyOptions)
        Enable the API key. Enable an API key. Users can manage user API keys for themself, or service ID API keys for service IDs they have access to.
        Parameters:
        enableApiKeyOptions - the EnableApiKeyOptions containing the options for the call
        Returns:
        a ServiceCall with a void result

      • createProfile

        public com.ibm.cloud.sdk.core.http.ServiceCall<TrustedProfile> createProfile​(CreateProfileOptions createProfileOptions)
        Create a trusted profile. Create a trusted profile for a given account ID.
        Parameters:
        createProfileOptions - the CreateProfileOptions containing the options for the call
        Returns:
        a ServiceCall with a result of type TrustedProfile

      • listProfiles

        public com.ibm.cloud.sdk.core.http.ServiceCall<TrustedProfilesList> listProfiles​(ListProfilesOptions listProfilesOptions)
        List trusted profiles. List the trusted profiles in an account. The `account_id` query parameter determines the account from which to retrieve the list of trusted profiles.
        Parameters:
        listProfilesOptions - the ListProfilesOptions containing the options for the call
        Returns:
        a ServiceCall with a result of type TrustedProfilesList

      • getProfile

        public com.ibm.cloud.sdk.core.http.ServiceCall<TrustedProfile> getProfile​(GetProfileOptions getProfileOptions)
        Get a trusted profile. Retrieve a trusted profile by its `profile-id`. Only the trusted profile's data is returned (`name`, `description`, `iam_id`, etc.), not the federated users or compute resources that qualify to apply the trusted profile.
        Parameters:
        getProfileOptions - the GetProfileOptions containing the options for the call
        Returns:
        a ServiceCall with a result of type TrustedProfile

      • updateProfile

        public com.ibm.cloud.sdk.core.http.ServiceCall<TrustedProfile> updateProfile​(UpdateProfileOptions updateProfileOptions)
        Update a trusted profile. Update the name or description of an existing trusted profile.
        Parameters:
        updateProfileOptions - the UpdateProfileOptions containing the options for the call
        Returns:
        a ServiceCall with a result of type TrustedProfile

      • deleteProfile

        public com.ibm.cloud.sdk.core.http.ServiceCall<java.lang.Void> deleteProfile​(DeleteProfileOptions deleteProfileOptions)
        Delete a trusted profile. Delete a trusted profile. When you delete trusted profile, compute resources and federated users are unlinked from the profile and can no longer apply the trusted profile identity.
        Parameters:
        deleteProfileOptions - the DeleteProfileOptions containing the options for the call
        Returns:
        a ServiceCall with a void result

      • createClaimRule

        public com.ibm.cloud.sdk.core.http.ServiceCall<ProfileClaimRule> createClaimRule​(CreateClaimRuleOptions createClaimRuleOptions)
        Create claim rule for a trusted profile. Create a claim rule for a trusted profile. There is a limit of 20 rules per trusted profile.
        Parameters:
        createClaimRuleOptions - the CreateClaimRuleOptions containing the options for the call
        Returns:
        a ServiceCall with a result of type ProfileClaimRule

      • listClaimRules

        public com.ibm.cloud.sdk.core.http.ServiceCall<ProfileClaimRuleList> listClaimRules​(ListClaimRulesOptions listClaimRulesOptions)
        List claim rules for a trusted profile. Get a list of all claim rules for a trusted profile. The `profile-id` query parameter determines the profile from which to retrieve the list of claim rules.
        Parameters:
        listClaimRulesOptions - the ListClaimRulesOptions containing the options for the call
        Returns:
        a ServiceCall with a result of type ProfileClaimRuleList

      • getClaimRule

        public com.ibm.cloud.sdk.core.http.ServiceCall<ProfileClaimRule> getClaimRule​(GetClaimRuleOptions getClaimRuleOptions)
        Get a claim rule for a trusted profile. A specific claim rule can be fetched for a given trusted profile ID and rule ID.
        Parameters:
        getClaimRuleOptions - the GetClaimRuleOptions containing the options for the call
        Returns:
        a ServiceCall with a result of type ProfileClaimRule

      • updateClaimRule

        public com.ibm.cloud.sdk.core.http.ServiceCall<ProfileClaimRule> updateClaimRule​(UpdateClaimRuleOptions updateClaimRuleOptions)
        Update claim rule for a trusted profile. Update a specific claim rule for a given trusted profile ID and rule ID.
        Parameters:
        updateClaimRuleOptions - the UpdateClaimRuleOptions containing the options for the call
        Returns:
        a ServiceCall with a result of type ProfileClaimRule

      • deleteClaimRule

        public com.ibm.cloud.sdk.core.http.ServiceCall<java.lang.Void> deleteClaimRule​(DeleteClaimRuleOptions deleteClaimRuleOptions)
        Delete a claim rule. Delete a claim rule. When you delete a claim rule, federated user or compute resources are no longer required to meet the conditions of the claim rule in order to apply the trusted profile.
        Parameters:
        deleteClaimRuleOptions - the DeleteClaimRuleOptions containing the options for the call
        Returns:
        a ServiceCall with a void result

      • createLink

        public com.ibm.cloud.sdk.core.http.ServiceCall<ProfileLink> createLink​(CreateLinkOptions createLinkOptions)
        Create link to a trusted profile. Create a direct link between a specific compute resource and a trusted profile, rather than creating conditions that a compute resource must fulfill to apply a trusted profile.
        Parameters:
        createLinkOptions - the CreateLinkOptions containing the options for the call
        Returns:
        a ServiceCall with a result of type ProfileLink

      • listLinks

        public com.ibm.cloud.sdk.core.http.ServiceCall<ProfileLinkList> listLinks​(ListLinksOptions listLinksOptions)
        List links to a trusted profile. Get a list of links to a trusted profile.
        Parameters:
        listLinksOptions - the ListLinksOptions containing the options for the call
        Returns:
        a ServiceCall with a result of type ProfileLinkList

      • deleteLinkByParameters

        public com.ibm.cloud.sdk.core.http.ServiceCall<java.lang.Void> deleteLinkByParameters​(DeleteLinkByParametersOptions deleteLinkByParametersOptions)
        Delete compute resource link to profile by given parameters. Deletes compute resource link of a Trusted Profile matching the given parameters.
        Parameters:
        deleteLinkByParametersOptions - the DeleteLinkByParametersOptions containing the options for the call
        Returns:
        a ServiceCall with a void result

      • getLink

        public com.ibm.cloud.sdk.core.http.ServiceCall<ProfileLink> getLink​(GetLinkOptions getLinkOptions)
        Get link to a trusted profile. Get a specific link to a trusted profile by `link_id`.
        Parameters:
        getLinkOptions - the GetLinkOptions containing the options for the call
        Returns:
        a ServiceCall with a result of type ProfileLink

      • deleteLink

        public com.ibm.cloud.sdk.core.http.ServiceCall<java.lang.Void> deleteLink​(DeleteLinkOptions deleteLinkOptions)
        Delete link to a trusted profile. Delete a link between a compute resource and a trusted profile.
        Parameters:
        deleteLinkOptions - the DeleteLinkOptions containing the options for the call
        Returns:
        a ServiceCall with a void result

      • setProfileIdentity

        public com.ibm.cloud.sdk.core.http.ServiceCall<ProfileIdentityResponse> setProfileIdentity​(SetProfileIdentityOptions setProfileIdentityOptions)
        Add a specific identity that can assume the trusted profile. Add a specific identity that can assume the trusted profile. **Note:** This API will update the trusted profile itself, thus calling it repeatedly for the same profile can lead to conflicts responded with HTTP code 409. Make sure to call this API only once in a few seconds for the same trusted profile.
        Parameters:
        setProfileIdentityOptions - the SetProfileIdentityOptions containing the options for the call
        Returns:
        a ServiceCall with a result of type ProfileIdentityResponse

      • deleteProfileIdentity

        public com.ibm.cloud.sdk.core.http.ServiceCall<java.lang.Void> deleteProfileIdentity​(DeleteProfileIdentityOptions deleteProfileIdentityOptions)
        Delete the identity that can assume the trusted profile. Delete the identity that can assume the trusted profile. **Note:** This API will update the trusted profile itself, thus calling it repeatedly for the same profile can lead to conflicts responded with HTTP code 409. Make sure to call this API only once in a few seconds for the same trusted profile.
        Parameters:
        deleteProfileIdentityOptions - the DeleteProfileIdentityOptions containing the options for the call
        Returns:
        a ServiceCall with a void result

      • createReport

        public com.ibm.cloud.sdk.core.http.ServiceCall<ReportReference> createReport​(CreateReportOptions createReportOptions)
        Trigger activity report for the account. Trigger activity report for the account by specifying the account ID. It can take a few minutes to generate the report for retrieval.
        Parameters:
        createReportOptions - the CreateReportOptions containing the options for the call
        Returns:
        a ServiceCall with a result of type ReportReference

      • getReport

        public com.ibm.cloud.sdk.core.http.ServiceCall<Report> getReport​(GetReportOptions getReportOptions)
        Get activity report for the account. Get activity report for the account by specifying the account ID and the reference that is generated by triggering the report. Reports older than a day are deleted when generating a new report.
        Parameters:
        getReportOptions - the GetReportOptions containing the options for the call
        Returns:
        a ServiceCall with a result of type Report

      • updateAccountSettings

        public com.ibm.cloud.sdk.core.http.ServiceCall<AccountSettingsResponse> updateAccountSettings​(UpdateAccountSettingsOptions updateAccountSettingsOptions)
        Update account configurations. Allows a user to configure settings on their account with regards to MFA, MFA excemption list, session lifetimes, access control for creating new identities, and enforcing IP restrictions on token creation.
        Parameters:
        updateAccountSettingsOptions - the UpdateAccountSettingsOptions containing the options for the call
        Returns:
        a ServiceCall with a result of type AccountSettingsResponse

      • getMfaStatus

        public com.ibm.cloud.sdk.core.http.ServiceCall<UserMfaEnrollments> getMfaStatus​(GetMfaStatusOptions getMfaStatusOptions)
        Get MFA enrollment status for a single user in the account. Get MFA enrollment status for a single user in the account.
        Parameters:
        getMfaStatusOptions - the GetMfaStatusOptions containing the options for the call
        Returns:
        a ServiceCall with a result of type UserMfaEnrollments

      • createMfaReport

        public com.ibm.cloud.sdk.core.http.ServiceCall<ReportReference> createMfaReport​(CreateMfaReportOptions createMfaReportOptions)
        Trigger MFA enrollment status report for the account. Trigger MFA enrollment status report for the account by specifying the account ID. It can take a few minutes to generate the report for retrieval.
        Parameters:
        createMfaReportOptions - the CreateMfaReportOptions containing the options for the call
        Returns:
        a ServiceCall with a result of type ReportReference

      • getMfaReport

        public com.ibm.cloud.sdk.core.http.ServiceCall<ReportMfaEnrollmentStatus> getMfaReport​(GetMfaReportOptions getMfaReportOptions)
        Get MFA enrollment status report for the account. Get MFA enrollment status report for the account by specifying the account ID and the reference that is generated by triggering the report. Reports older than a day are deleted when generating a new report.
        Parameters:
        getMfaReportOptions - the GetMfaReportOptions containing the options for the call
        Returns:
        a ServiceCall with a result of type ReportMfaEnrollmentStatus

      • updatePreferenceOnScopeAccount

        public com.ibm.cloud.sdk.core.http.ServiceCall<IdentityPreferenceResponse> updatePreferenceOnScopeAccount​(UpdatePreferenceOnScopeAccountOptions updatePreferenceOnScopeAccountOptions)
        Update Identity Preference on scope account. Update one Identity Preference on scope `account`. The following preferences are storing values for identities inside an account, i.e. for each account that an identity is member of, the value stored might be different. This means, **users** who might be member of multiple accounts can have multiple preferences, one per account. Identities like **Service Ids** or **Trusted Profiles** can only exist in one account, therefore they can only have one preference inside their related account. ### Preferences - **console/landing_page** service: `console` preference_id: `landing_page` supported identity types: `Trusted Profile` type: `string` validation: valid path for the IBM Cloud Console (without host part), e.g. `/billing` or `/iam` - **console/global_left_navigation** service: `console` preference_id: `global_left_navigation` supported identity types: `Trusted Profile` type: `list of strings` validation: each entry in the list of strings must match the identifier of one navigation entry in the console; these identifiers are defined and interpreted by the IBM Cloud Console; currently the following entries are supported: `slash,projects,rex,containers,databases,is,logmet,automation,complianceAndSecurity,apis,cp4d,partner-center,sap,satellite,vmWare,watsonx` ### Authorization To call this method for the identity type `Trusted Profile`, you must be assigned one or more IAM access roles that include the following action on the target resource `account` and resource type `preferences`: - iam-identity.preferences.update By default, the `Administrator` role on service `iam-identity` contains this action.
        Parameters:
        updatePreferenceOnScopeAccountOptions - the UpdatePreferenceOnScopeAccountOptions containing the options for the call
        Returns:
        a ServiceCall with a result of type IdentityPreferenceResponse

      • deletePreferencesOnScopeAccount

        public com.ibm.cloud.sdk.core.http.ServiceCall<java.lang.Void> deletePreferencesOnScopeAccount​(DeletePreferencesOnScopeAccountOptions deletePreferencesOnScopeAccountOptions)
        Delete Identity Preference on scope account. Delete one Identity Preference on scope `account`. For details about the preferences supported and how the method request is authorized, refer to the description of operation `Update Identity Preference on scope account`.
        Parameters:
        deletePreferencesOnScopeAccountOptions - the DeletePreferencesOnScopeAccountOptions containing the options for the call
        Returns:
        a ServiceCall with a void result

      • getPreferencesOnScopeAccount

        public com.ibm.cloud.sdk.core.http.ServiceCall<IdentityPreferenceResponse> getPreferencesOnScopeAccount​(GetPreferencesOnScopeAccountOptions getPreferencesOnScopeAccountOptions)
        Get Identity Preference on scope account. Get one Identity Preference on scope `account`. For details about the preferences supported, refer to the description of operation `Update Identity Preference on scope account`. ### Authorization To call this method for the identity type `Trusted Profile`, one of the following conditions must be true: - the Authorization token represents the trusted profile which is addressed by this request - you must be assigned one or more IAM access roles that include the following action on the target resource `account` and resource type `preferences`: - iam-identity.preferences.update By default, the `Administrator` role on service `iam-identity` contains this action. - Services inside the IBM Cloud Console can call this method.
        Parameters:
        getPreferencesOnScopeAccountOptions - the GetPreferencesOnScopeAccountOptions containing the options for the call
        Returns:
        a ServiceCall with a result of type IdentityPreferenceResponse

      • getAllPreferencesOnScopeAccount

        public com.ibm.cloud.sdk.core.http.ServiceCall<IdentityPreferencesResponse> getAllPreferencesOnScopeAccount​(GetAllPreferencesOnScopeAccountOptions getAllPreferencesOnScopeAccountOptions)
        Get all Identity Preferences on scope account. Get all Identity Preferences for one account / identity combination. For details about the preferences supported and how the method request is authorized, refer to the description of operation `Get Identity Preference on scope account`. If you are not allowed to read a preference, the call will not fail. Instead, this preference is/ these preferences are not returned in the list call.
        Parameters:
        getAllPreferencesOnScopeAccountOptions - the GetAllPreferencesOnScopeAccountOptions containing the options for the call
        Returns:
        a ServiceCall with a result of type IdentityPreferencesResponse

      • listProfileTemplates

        public com.ibm.cloud.sdk.core.http.ServiceCall<TrustedProfileTemplateList> listProfileTemplates()
        List trusted profile templates. List the trusted profile templates in an enterprise account.
        Returns:
        a ServiceCall with a result of type TrustedProfileTemplateList

      • createProfileTemplate

        public com.ibm.cloud.sdk.core.http.ServiceCall<TrustedProfileTemplateResponse> createProfileTemplate()
        Create a trusted profile template. Create a new trusted profile template in an enterprise account.
        Returns:
        a ServiceCall with a result of type TrustedProfileTemplateResponse

      • deleteAllVersionsOfProfileTemplate

        public com.ibm.cloud.sdk.core.http.ServiceCall<java.lang.Void> deleteAllVersionsOfProfileTemplate​(DeleteAllVersionsOfProfileTemplateOptions deleteAllVersionsOfProfileTemplateOptions)
        Delete all versions of a trusted profile template. Delete all versions of a trusted profile template in an enterprise account. If any version is assigned to child accounts, you must first delete the assignment.
        Parameters:
        deleteAllVersionsOfProfileTemplateOptions - the DeleteAllVersionsOfProfileTemplateOptions containing the options for the call
        Returns:
        a ServiceCall with a void result

      • deleteProfileTemplateVersion

        public com.ibm.cloud.sdk.core.http.ServiceCall<java.lang.Void> deleteProfileTemplateVersion​(DeleteProfileTemplateVersionOptions deleteProfileTemplateVersionOptions)
        Delete version of trusted profile template. Delete a specific version of a trusted profile template in an enterprise account. If the version is assigned to child accounts, you must first delete the assignment.
        Parameters:
        deleteProfileTemplateVersionOptions - the DeleteProfileTemplateVersionOptions containing the options for the call
        Returns:
        a ServiceCall with a void result

      • commitProfileTemplate

        public com.ibm.cloud.sdk.core.http.ServiceCall<java.lang.Void> commitProfileTemplate​(CommitProfileTemplateOptions commitProfileTemplateOptions)
        Commit a template version. Commit a specific version of a trusted profile template in an enterprise account. You must commit a template before you can assign it to child accounts. Once a template is committed, you can no longer modify the template.
        Parameters:
        commitProfileTemplateOptions - the CommitProfileTemplateOptions containing the options for the call
        Returns:
        a ServiceCall with a void result

      • listAccountSettingsTemplates

        public com.ibm.cloud.sdk.core.http.ServiceCall<AccountSettingsTemplateList> listAccountSettingsTemplates()
        List account settings templates. List account settings templates in an enterprise account.
        Returns:
        a ServiceCall with a result of type AccountSettingsTemplateList

      • createAccountSettingsTemplate

        public com.ibm.cloud.sdk.core.http.ServiceCall<AccountSettingsTemplateResponse> createAccountSettingsTemplate()
        Create an account settings template. Create a new account settings template in an enterprise account.
        Returns:
        a ServiceCall with a result of type AccountSettingsTemplateResponse

      • deleteAllVersionsOfAccountSettingsTemplate

        public com.ibm.cloud.sdk.core.http.ServiceCall<java.lang.Void> deleteAllVersionsOfAccountSettingsTemplate​(DeleteAllVersionsOfAccountSettingsTemplateOptions deleteAllVersionsOfAccountSettingsTemplateOptions)
        Delete all versions of an account settings template. Delete all versions of an account settings template in an enterprise account. If any version is assigned to child accounts, you must first delete the assignment.
        Parameters:
        deleteAllVersionsOfAccountSettingsTemplateOptions - the DeleteAllVersionsOfAccountSettingsTemplateOptions containing the options for the call
        Returns:
        a ServiceCall with a void result

      • deleteAccountSettingsTemplateVersion

        public com.ibm.cloud.sdk.core.http.ServiceCall<java.lang.Void> deleteAccountSettingsTemplateVersion​(DeleteAccountSettingsTemplateVersionOptions deleteAccountSettingsTemplateVersionOptions)
        Delete version of an account settings template. Delete a specific version of an account settings template in an Enterprise Account.
        Parameters:
        deleteAccountSettingsTemplateVersionOptions - the DeleteAccountSettingsTemplateVersionOptions containing the options for the call
        Returns:
        a ServiceCall with a void result

      • commitAccountSettingsTemplate

        public com.ibm.cloud.sdk.core.http.ServiceCall<java.lang.Void> commitAccountSettingsTemplate​(CommitAccountSettingsTemplateOptions commitAccountSettingsTemplateOptions)
        Commit a template version. Commit a specific version of an account settings template in an Enterprise Account. A Template must be committed before being assigned, and once committed, can no longer be modified.
        Parameters:
        commitAccountSettingsTemplateOptions - the CommitAccountSettingsTemplateOptions containing the options for the call
        Returns:
        a ServiceCall with a void result

      • deleteAccountSettingsAssignment

        public com.ibm.cloud.sdk.core.http.ServiceCall<ExceptionResponse> deleteAccountSettingsAssignment​(DeleteAccountSettingsAssignmentOptions deleteAccountSettingsAssignmentOptions)
        Delete assignment. Delete an account settings template assignment. This removes any IAM resources created by this assignment in child accounts.
        Parameters:
        deleteAccountSettingsAssignmentOptions - the DeleteAccountSettingsAssignmentOptions containing the options for the call
        Returns:
        a ServiceCall with a result of type ExceptionResponse