Class IamIdentity
- java.lang.Object
-
- com.ibm.cloud.sdk.core.service.BaseService
-
- com.ibm.cloud.platform_services.iam_identity.v1.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 Summary
Fields Modifier and Type Field Description static java.lang.String
DEFAULT_SERVICE_NAME
Default service name used when configuring the `IamIdentity` client.static java.lang.String
DEFAULT_SERVICE_URL
Default service endpoint URL.
-
Constructor Summary
Constructors Constructor Description IamIdentity(java.lang.String serviceName, com.ibm.cloud.sdk.core.security.Authenticator authenticator)
Constructs an instance of the `IamIdentity` client.
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description com.ibm.cloud.sdk.core.http.ServiceCall<java.lang.Void>
commitAccountSettingsTemplate(CommitAccountSettingsTemplateOptions commitAccountSettingsTemplateOptions)
Commit a template version.com.ibm.cloud.sdk.core.http.ServiceCall<java.lang.Void>
commitProfileTemplate(CommitProfileTemplateOptions commitProfileTemplateOptions)
Commit a template version.com.ibm.cloud.sdk.core.http.ServiceCall<TemplateAssignmentResponse>
createAccountSettingsAssignment(CreateAccountSettingsAssignmentOptions createAccountSettingsAssignmentOptions)
Create assignment.com.ibm.cloud.sdk.core.http.ServiceCall<AccountSettingsTemplateResponse>
createAccountSettingsTemplate()
Create an account settings template.com.ibm.cloud.sdk.core.http.ServiceCall<AccountSettingsTemplateResponse>
createAccountSettingsTemplate(CreateAccountSettingsTemplateOptions createAccountSettingsTemplateOptions)
Create an account settings template.com.ibm.cloud.sdk.core.http.ServiceCall<AccountSettingsTemplateResponse>
createAccountSettingsTemplateVersion(CreateAccountSettingsTemplateVersionOptions createAccountSettingsTemplateVersionOptions)
Create a new version of an account settings template.com.ibm.cloud.sdk.core.http.ServiceCall<ApiKey>
createApiKey(CreateApiKeyOptions createApiKeyOptions)
Create an API key.com.ibm.cloud.sdk.core.http.ServiceCall<ProfileClaimRule>
createClaimRule(CreateClaimRuleOptions createClaimRuleOptions)
Create claim rule for a trusted profile.com.ibm.cloud.sdk.core.http.ServiceCall<ProfileLink>
createLink(CreateLinkOptions createLinkOptions)
Create link to a trusted profile.com.ibm.cloud.sdk.core.http.ServiceCall<ReportReference>
createMfaReport(CreateMfaReportOptions createMfaReportOptions)
Trigger MFA enrollment status report for the account.com.ibm.cloud.sdk.core.http.ServiceCall<TrustedProfile>
createProfile(CreateProfileOptions createProfileOptions)
Create a trusted profile.com.ibm.cloud.sdk.core.http.ServiceCall<TrustedProfileTemplateResponse>
createProfileTemplate()
Create a trusted profile template.com.ibm.cloud.sdk.core.http.ServiceCall<TrustedProfileTemplateResponse>
createProfileTemplate(CreateProfileTemplateOptions createProfileTemplateOptions)
Create a trusted profile template.com.ibm.cloud.sdk.core.http.ServiceCall<TrustedProfileTemplateResponse>
createProfileTemplateVersion(CreateProfileTemplateVersionOptions createProfileTemplateVersionOptions)
Create new version of a trusted profile template.com.ibm.cloud.sdk.core.http.ServiceCall<ReportReference>
createReport(CreateReportOptions createReportOptions)
Trigger activity report for the account.com.ibm.cloud.sdk.core.http.ServiceCall<ServiceId>
createServiceId(CreateServiceIdOptions createServiceIdOptions)
Create a service ID.com.ibm.cloud.sdk.core.http.ServiceCall<TemplateAssignmentResponse>
createTrustedProfileAssignment(CreateTrustedProfileAssignmentOptions createTrustedProfileAssignmentOptions)
Create assignment.com.ibm.cloud.sdk.core.http.ServiceCall<ExceptionResponse>
deleteAccountSettingsAssignment(DeleteAccountSettingsAssignmentOptions deleteAccountSettingsAssignmentOptions)
Delete assignment.com.ibm.cloud.sdk.core.http.ServiceCall<java.lang.Void>
deleteAccountSettingsTemplateVersion(DeleteAccountSettingsTemplateVersionOptions deleteAccountSettingsTemplateVersionOptions)
Delete version of an account settings template.com.ibm.cloud.sdk.core.http.ServiceCall<java.lang.Void>
deleteAllVersionsOfAccountSettingsTemplate(DeleteAllVersionsOfAccountSettingsTemplateOptions deleteAllVersionsOfAccountSettingsTemplateOptions)
Delete all versions of an account settings template.com.ibm.cloud.sdk.core.http.ServiceCall<java.lang.Void>
deleteAllVersionsOfProfileTemplate(DeleteAllVersionsOfProfileTemplateOptions deleteAllVersionsOfProfileTemplateOptions)
Delete all versions of a trusted profile template.com.ibm.cloud.sdk.core.http.ServiceCall<java.lang.Void>
deleteApiKey(DeleteApiKeyOptions deleteApiKeyOptions)
Deletes an API key.com.ibm.cloud.sdk.core.http.ServiceCall<java.lang.Void>
deleteClaimRule(DeleteClaimRuleOptions deleteClaimRuleOptions)
Delete a claim rule.com.ibm.cloud.sdk.core.http.ServiceCall<java.lang.Void>
deleteLink(DeleteLinkOptions deleteLinkOptions)
Delete link to a trusted profile.com.ibm.cloud.sdk.core.http.ServiceCall<java.lang.Void>
deleteProfile(DeleteProfileOptions deleteProfileOptions)
Delete a trusted profile.com.ibm.cloud.sdk.core.http.ServiceCall<java.lang.Void>
deleteProfileIdentity(DeleteProfileIdentityOptions deleteProfileIdentityOptions)
Delete the identity that can assume the trusted profile.com.ibm.cloud.sdk.core.http.ServiceCall<java.lang.Void>
deleteProfileTemplateVersion(DeleteProfileTemplateVersionOptions deleteProfileTemplateVersionOptions)
Delete version of trusted profile template.com.ibm.cloud.sdk.core.http.ServiceCall<java.lang.Void>
deleteServiceId(DeleteServiceIdOptions deleteServiceIdOptions)
Deletes a service ID and associated API keys.com.ibm.cloud.sdk.core.http.ServiceCall<ExceptionResponse>
deleteTrustedProfileAssignment(DeleteTrustedProfileAssignmentOptions deleteTrustedProfileAssignmentOptions)
Delete assignment.com.ibm.cloud.sdk.core.http.ServiceCall<java.lang.Void>
disableApiKey(DisableApiKeyOptions disableApiKeyOptions)
disable the API key.com.ibm.cloud.sdk.core.http.ServiceCall<java.lang.Void>
enableApiKey(EnableApiKeyOptions enableApiKeyOptions)
Enable the API key.com.ibm.cloud.sdk.core.http.ServiceCall<AccountSettingsResponse>
getAccountSettings(GetAccountSettingsOptions getAccountSettingsOptions)
Get account configurations.com.ibm.cloud.sdk.core.http.ServiceCall<TemplateAssignmentResponse>
getAccountSettingsAssignment(GetAccountSettingsAssignmentOptions getAccountSettingsAssignmentOptions)
Get assignment.com.ibm.cloud.sdk.core.http.ServiceCall<AccountSettingsTemplateResponse>
getAccountSettingsTemplateVersion(GetAccountSettingsTemplateVersionOptions getAccountSettingsTemplateVersionOptions)
Get version of an account settings template.com.ibm.cloud.sdk.core.http.ServiceCall<ApiKey>
getApiKey(GetApiKeyOptions getApiKeyOptions)
Get details of an API key.com.ibm.cloud.sdk.core.http.ServiceCall<ApiKey>
getApiKeysDetails()
Get details of an API key by its value.com.ibm.cloud.sdk.core.http.ServiceCall<ApiKey>
getApiKeysDetails(GetApiKeysDetailsOptions getApiKeysDetailsOptions)
Get details of an API key by its value.com.ibm.cloud.sdk.core.http.ServiceCall<ProfileClaimRule>
getClaimRule(GetClaimRuleOptions getClaimRuleOptions)
Get a claim rule for a trusted profile.com.ibm.cloud.sdk.core.http.ServiceCall<AccountSettingsTemplateResponse>
getLatestAccountSettingsTemplateVersion(GetLatestAccountSettingsTemplateVersionOptions getLatestAccountSettingsTemplateVersionOptions)
Get latest version of an account settings template.com.ibm.cloud.sdk.core.http.ServiceCall<TrustedProfileTemplateResponse>
getLatestProfileTemplateVersion(GetLatestProfileTemplateVersionOptions getLatestProfileTemplateVersionOptions)
Get latest version of a trusted profile template.com.ibm.cloud.sdk.core.http.ServiceCall<ProfileLink>
getLink(GetLinkOptions getLinkOptions)
Get link to a trusted profile.com.ibm.cloud.sdk.core.http.ServiceCall<ReportMfaEnrollmentStatus>
getMfaReport(GetMfaReportOptions getMfaReportOptions)
Get MFA enrollment status report for the account.com.ibm.cloud.sdk.core.http.ServiceCall<UserMfaEnrollments>
getMfaStatus(GetMfaStatusOptions getMfaStatusOptions)
Get MFA enrollment status for a single user in the account.com.ibm.cloud.sdk.core.http.ServiceCall<TrustedProfile>
getProfile(GetProfileOptions getProfileOptions)
Get a trusted profile.com.ibm.cloud.sdk.core.http.ServiceCall<ProfileIdentitiesResponse>
getProfileIdentities(GetProfileIdentitiesOptions getProfileIdentitiesOptions)
Get a list of identities that can assume the trusted profile.com.ibm.cloud.sdk.core.http.ServiceCall<ProfileIdentityResponse>
getProfileIdentity(GetProfileIdentityOptions getProfileIdentityOptions)
Get the identity that can assume the trusted profile.com.ibm.cloud.sdk.core.http.ServiceCall<TrustedProfileTemplateResponse>
getProfileTemplateVersion(GetProfileTemplateVersionOptions getProfileTemplateVersionOptions)
Get version of trusted profile template.com.ibm.cloud.sdk.core.http.ServiceCall<Report>
getReport(GetReportOptions getReportOptions)
Get activity report for the account.com.ibm.cloud.sdk.core.http.ServiceCall<ServiceId>
getServiceId(GetServiceIdOptions getServiceIdOptions)
Get details of a service ID.com.ibm.cloud.sdk.core.http.ServiceCall<TemplateAssignmentResponse>
getTrustedProfileAssignment(GetTrustedProfileAssignmentOptions getTrustedProfileAssignmentOptions)
Get assignment.com.ibm.cloud.sdk.core.http.ServiceCall<TemplateAssignmentListResponse>
listAccountSettingsAssignments()
List assignments.com.ibm.cloud.sdk.core.http.ServiceCall<TemplateAssignmentListResponse>
listAccountSettingsAssignments(ListAccountSettingsAssignmentsOptions listAccountSettingsAssignmentsOptions)
List assignments.com.ibm.cloud.sdk.core.http.ServiceCall<AccountSettingsTemplateList>
listAccountSettingsTemplates()
List account settings templates.com.ibm.cloud.sdk.core.http.ServiceCall<AccountSettingsTemplateList>
listAccountSettingsTemplates(ListAccountSettingsTemplatesOptions listAccountSettingsTemplatesOptions)
List account settings templates.com.ibm.cloud.sdk.core.http.ServiceCall<ApiKeyList>
listApiKeys()
Get API keys for a given service or user IAM ID and account ID.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.com.ibm.cloud.sdk.core.http.ServiceCall<ProfileClaimRuleList>
listClaimRules(ListClaimRulesOptions listClaimRulesOptions)
List claim rules for a trusted profile.com.ibm.cloud.sdk.core.http.ServiceCall<ProfileLinkList>
listLinks(ListLinksOptions listLinksOptions)
List links to a trusted profile.com.ibm.cloud.sdk.core.http.ServiceCall<TrustedProfilesList>
listProfiles(ListProfilesOptions listProfilesOptions)
List trusted profiles.com.ibm.cloud.sdk.core.http.ServiceCall<TrustedProfileTemplateList>
listProfileTemplates()
List trusted profile templates.com.ibm.cloud.sdk.core.http.ServiceCall<TrustedProfileTemplateList>
listProfileTemplates(ListProfileTemplatesOptions listProfileTemplatesOptions)
List trusted profile templates.com.ibm.cloud.sdk.core.http.ServiceCall<ServiceIdList>
listServiceIds()
List service IDs.com.ibm.cloud.sdk.core.http.ServiceCall<ServiceIdList>
listServiceIds(ListServiceIdsOptions listServiceIdsOptions)
List service IDs.com.ibm.cloud.sdk.core.http.ServiceCall<TemplateAssignmentListResponse>
listTrustedProfileAssignments()
List assignments.com.ibm.cloud.sdk.core.http.ServiceCall<TemplateAssignmentListResponse>
listTrustedProfileAssignments(ListTrustedProfileAssignmentsOptions listTrustedProfileAssignmentsOptions)
List assignments.com.ibm.cloud.sdk.core.http.ServiceCall<AccountSettingsTemplateList>
listVersionsOfAccountSettingsTemplate(ListVersionsOfAccountSettingsTemplateOptions listVersionsOfAccountSettingsTemplateOptions)
List account settings template versions.com.ibm.cloud.sdk.core.http.ServiceCall<TrustedProfileTemplateList>
listVersionsOfProfileTemplate(ListVersionsOfProfileTemplateOptions listVersionsOfProfileTemplateOptions)
List trusted profile template versions.com.ibm.cloud.sdk.core.http.ServiceCall<java.lang.Void>
lockApiKey(LockApiKeyOptions lockApiKeyOptions)
Lock the API key.com.ibm.cloud.sdk.core.http.ServiceCall<java.lang.Void>
lockServiceId(LockServiceIdOptions lockServiceIdOptions)
Lock the service ID.static IamIdentity
newInstance()
Class method which constructs an instance of the `IamIdentity` client.static IamIdentity
newInstance(java.lang.String serviceName)
Class method which constructs an instance of the `IamIdentity` client.com.ibm.cloud.sdk.core.http.ServiceCall<ProfileIdentitiesResponse>
setProfileIdentities(SetProfileIdentitiesOptions setProfileIdentitiesOptions)
Update the list of identities that can assume the trusted profile.com.ibm.cloud.sdk.core.http.ServiceCall<ProfileIdentityResponse>
setProfileIdentity(SetProfileIdentityOptions setProfileIdentityOptions)
Add a specific identity that can assume the trusted profile.com.ibm.cloud.sdk.core.http.ServiceCall<java.lang.Void>
unlockApiKey(UnlockApiKeyOptions unlockApiKeyOptions)
Unlock the API key.com.ibm.cloud.sdk.core.http.ServiceCall<java.lang.Void>
unlockServiceId(UnlockServiceIdOptions unlockServiceIdOptions)
Unlock the service ID.com.ibm.cloud.sdk.core.http.ServiceCall<AccountSettingsResponse>
updateAccountSettings(UpdateAccountSettingsOptions updateAccountSettingsOptions)
Update account configurations.com.ibm.cloud.sdk.core.http.ServiceCall<TemplateAssignmentResponse>
updateAccountSettingsAssignment(UpdateAccountSettingsAssignmentOptions updateAccountSettingsAssignmentOptions)
Update assignment.com.ibm.cloud.sdk.core.http.ServiceCall<AccountSettingsTemplateResponse>
updateAccountSettingsTemplateVersion(UpdateAccountSettingsTemplateVersionOptions updateAccountSettingsTemplateVersionOptions)
Update version of an account settings template.com.ibm.cloud.sdk.core.http.ServiceCall<ApiKey>
updateApiKey(UpdateApiKeyOptions updateApiKeyOptions)
Updates an API key.com.ibm.cloud.sdk.core.http.ServiceCall<ProfileClaimRule>
updateClaimRule(UpdateClaimRuleOptions updateClaimRuleOptions)
Update claim rule for a trusted profile.com.ibm.cloud.sdk.core.http.ServiceCall<TrustedProfile>
updateProfile(UpdateProfileOptions updateProfileOptions)
Update a trusted profile.com.ibm.cloud.sdk.core.http.ServiceCall<TrustedProfileTemplateResponse>
updateProfileTemplateVersion(UpdateProfileTemplateVersionOptions updateProfileTemplateVersionOptions)
Update version of trusted profile template.com.ibm.cloud.sdk.core.http.ServiceCall<ServiceId>
updateServiceId(UpdateServiceIdOptions updateServiceIdOptions)
Update service ID.com.ibm.cloud.sdk.core.http.ServiceCall<TemplateAssignmentResponse>
updateTrustedProfileAssignment(UpdateTrustedProfileAssignmentOptions updateTrustedProfileAssignmentOptions)
Update assignment.-
Methods inherited from class com.ibm.cloud.sdk.core.service.BaseService
configureClient, configureService, constructServiceUrl, constructServiceURL, disableRetries, enableGzipCompression, enableRetries, getAuthenticator, getClient, getDefaultHeaders, getEndPoint, getName, getServiceUrl, isJsonMimeType, isJsonPatchMimeType, setClient, setDefaultHeaders, setEndPoint, setServiceUrl, toString
-
-
-
-
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 instanceauthenticator
- theAuthenticator
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
-
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 that are bound to an entity they have access to. In case of service IDs and their API keys, a user must be either an account owner, a IBM Cloud org manager or IBM Cloud space developer in order to manage service IDs of the entity.- Parameters:
listApiKeysOptions
- theListApiKeysOptions
containing the options for the call- Returns:
- a
ServiceCall
with a result of typeApiKeyList
-
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 that are bound to an entity they have access to. In case of service IDs and their API keys, a user must be either an account owner, a IBM Cloud org manager or IBM Cloud space developer in order to manage service IDs of the entity.- Returns:
- a
ServiceCall
with a result of typeApiKeyList
-
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 that are bound to an entity they have access to.- Parameters:
createApiKeyOptions
- theCreateApiKeyOptions
containing the options for the call- Returns:
- a
ServiceCall
with a result of typeApiKey
-
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 that are bound to an entity they have access to.- Parameters:
getApiKeysDetailsOptions
- theGetApiKeysDetailsOptions
containing the options for the call- Returns:
- a
ServiceCall
with a result of typeApiKey
-
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 that are bound to an entity they have access to.- Returns:
- a
ServiceCall
with a result of typeApiKey
-
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 that are bound to an entity they have access to. In case of service IDs and their API keys, a user must be either an account owner, a IBM Cloud org manager or IBM Cloud space developer in order to manage service IDs of the entity.- Parameters:
getApiKeyOptions
- theGetApiKeyOptions
containing the options for the call- Returns:
- a
ServiceCall
with a result of typeApiKey
-
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 that are bound to an entity they have access to.- Parameters:
updateApiKeyOptions
- theUpdateApiKeyOptions
containing the options for the call- Returns:
- a
ServiceCall
with a result of typeApiKey
-
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 that are bound to an entity they have access to.- Parameters:
deleteApiKeyOptions
- theDeleteApiKeyOptions
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 that are bound to an entity they have access to. In case of service IDs and their API keys, a user must be either an account owner, a IBM Cloud org manager or IBM Cloud space developer in order to manage service IDs of the entity.- Parameters:
lockApiKeyOptions
- theLockApiKeyOptions
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 that are bound to an entity they have access to. In case of service IDs and their API keys, a user must be either an account owner, a IBM Cloud org manager or IBM Cloud space developer in order to manage service IDs of the entity.- Parameters:
unlockApiKeyOptions
- theUnlockApiKeyOptions
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 that are bound to an entity they have access to.- Parameters:
disableApiKeyOptions
- theDisableApiKeyOptions
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 that are bound to an entity they have access to.- Parameters:
enableApiKeyOptions
- theEnableApiKeyOptions
containing the options for the call- Returns:
- a
ServiceCall
with a void result
-
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 that are bound to an entity they have access to. Note: apikey details are only included in the response when creating a Service ID with an api key.- Parameters:
listServiceIdsOptions
- theListServiceIdsOptions
containing the options for the call- Returns:
- a
ServiceCall
with a result of typeServiceIdList
-
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 that are bound to an entity 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 typeServiceIdList
-
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 that are bound to an entity they have access to.- Parameters:
createServiceIdOptions
- theCreateServiceIdOptions
containing the options for the call- Returns:
- a
ServiceCall
with a result of typeServiceId
-
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 that are bound to an entity they have access to. Note: apikey details are only included in the response when creating a Service ID with an api key.- Parameters:
getServiceIdOptions
- theGetServiceIdOptions
containing the options for the call- Returns:
- a
ServiceCall
with a result of typeServiceId
-
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 that are bound to an entity they have access to. Note: apikey details are only included in the response when creating a Service ID with an apikey.- Parameters:
updateServiceIdOptions
- theUpdateServiceIdOptions
containing the options for the call- Returns:
- a
ServiceCall
with a result of typeServiceId
-
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 that are bound to an entity they have access to.- Parameters:
deleteServiceIdOptions
- theDeleteServiceIdOptions
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 that are bound to an entity they have access to. In case of service IDs and their API keys, a user must be either an account owner, a IBM Cloud org manager or IBM Cloud space developer in order to manage service IDs of the entity.- Parameters:
lockServiceIdOptions
- theLockServiceIdOptions
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 that are bound to an entity they have access to. In case of service IDs and their API keys, a user must be either an account owner, a IBM Cloud org manager or IBM Cloud space developer in order to manage service IDs of the entity.- Parameters:
unlockServiceIdOptions
- theUnlockServiceIdOptions
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
- theCreateProfileOptions
containing the options for the call- Returns:
- a
ServiceCall
with a result of typeTrustedProfile
-
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
- theListProfilesOptions
containing the options for the call- Returns:
- a
ServiceCall
with a result of typeTrustedProfilesList
-
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
- theGetProfileOptions
containing the options for the call- Returns:
- a
ServiceCall
with a result of typeTrustedProfile
-
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
- theUpdateProfileOptions
containing the options for the call- Returns:
- a
ServiceCall
with a result of typeTrustedProfile
-
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
- theDeleteProfileOptions
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
- theCreateClaimRuleOptions
containing the options for the call- Returns:
- a
ServiceCall
with a result of typeProfileClaimRule
-
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
- theListClaimRulesOptions
containing the options for the call- Returns:
- a
ServiceCall
with a result of typeProfileClaimRuleList
-
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
- theGetClaimRuleOptions
containing the options for the call- Returns:
- a
ServiceCall
with a result of typeProfileClaimRule
-
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
- theUpdateClaimRuleOptions
containing the options for the call- Returns:
- a
ServiceCall
with a result of typeProfileClaimRule
-
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
- theDeleteClaimRuleOptions
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
- theCreateLinkOptions
containing the options for the call- Returns:
- a
ServiceCall
with a result of typeProfileLink
-
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
- theListLinksOptions
containing the options for the call- Returns:
- a
ServiceCall
with a result of typeProfileLinkList
-
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
- theGetLinkOptions
containing the options for the call- Returns:
- a
ServiceCall
with a result of typeProfileLink
-
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
- theDeleteLinkOptions
containing the options for the call- Returns:
- a
ServiceCall
with a void result
-
getProfileIdentities
public com.ibm.cloud.sdk.core.http.ServiceCall<ProfileIdentitiesResponse> getProfileIdentities(GetProfileIdentitiesOptions getProfileIdentitiesOptions)
Get a list of identities that can assume the trusted profile. Get a list of identities that can assume the trusted profile.- Parameters:
getProfileIdentitiesOptions
- theGetProfileIdentitiesOptions
containing the options for the call- Returns:
- a
ServiceCall
with a result of typeProfileIdentitiesResponse
-
setProfileIdentities
public com.ibm.cloud.sdk.core.http.ServiceCall<ProfileIdentitiesResponse> setProfileIdentities(SetProfileIdentitiesOptions setProfileIdentitiesOptions)
Update the list of identities that can assume the trusted profile. Update the list of identities that can assume the trusted profile.- Parameters:
setProfileIdentitiesOptions
- theSetProfileIdentitiesOptions
containing the options for the call- Returns:
- a
ServiceCall
with a result of typeProfileIdentitiesResponse
-
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.- Parameters:
setProfileIdentityOptions
- theSetProfileIdentityOptions
containing the options for the call- Returns:
- a
ServiceCall
with a result of typeProfileIdentityResponse
-
getProfileIdentity
public com.ibm.cloud.sdk.core.http.ServiceCall<ProfileIdentityResponse> getProfileIdentity(GetProfileIdentityOptions getProfileIdentityOptions)
Get the identity that can assume the trusted profile. Get the identity that can assume the trusted profile.- Parameters:
getProfileIdentityOptions
- theGetProfileIdentityOptions
containing the options for the call- Returns:
- a
ServiceCall
with a result of typeProfileIdentityResponse
-
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.- Parameters:
deleteProfileIdentityOptions
- theDeleteProfileIdentityOptions
containing the options for the call- Returns:
- a
ServiceCall
with a void result
-
getAccountSettings
public com.ibm.cloud.sdk.core.http.ServiceCall<AccountSettingsResponse> getAccountSettings(GetAccountSettingsOptions getAccountSettingsOptions)
Get account configurations. Returns the details of an account's configuration.- Parameters:
getAccountSettingsOptions
- theGetAccountSettingsOptions
containing the options for the call- Returns:
- a
ServiceCall
with a result of typeAccountSettingsResponse
-
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
- theUpdateAccountSettingsOptions
containing the options for the call- Returns:
- a
ServiceCall
with a result of typeAccountSettingsResponse
-
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
- theGetMfaStatusOptions
containing the options for the call- Returns:
- a
ServiceCall
with a result of typeUserMfaEnrollments
-
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
- theCreateMfaReportOptions
containing the options for the call- Returns:
- a
ServiceCall
with a result of typeReportReference
-
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
- theGetMfaReportOptions
containing the options for the call- Returns:
- a
ServiceCall
with a result of typeReportMfaEnrollmentStatus
-
listAccountSettingsAssignments
public com.ibm.cloud.sdk.core.http.ServiceCall<TemplateAssignmentListResponse> listAccountSettingsAssignments(ListAccountSettingsAssignmentsOptions listAccountSettingsAssignmentsOptions)
List assignments. List account settings assignments.- Parameters:
listAccountSettingsAssignmentsOptions
- theListAccountSettingsAssignmentsOptions
containing the options for the call- Returns:
- a
ServiceCall
with a result of typeTemplateAssignmentListResponse
-
listAccountSettingsAssignments
public com.ibm.cloud.sdk.core.http.ServiceCall<TemplateAssignmentListResponse> listAccountSettingsAssignments()
List assignments. List account settings assignments.- Returns:
- a
ServiceCall
with a result of typeTemplateAssignmentListResponse
-
createAccountSettingsAssignment
public com.ibm.cloud.sdk.core.http.ServiceCall<TemplateAssignmentResponse> createAccountSettingsAssignment(CreateAccountSettingsAssignmentOptions createAccountSettingsAssignmentOptions)
Create assignment. Create an assigment for an account settings template.- Parameters:
createAccountSettingsAssignmentOptions
- theCreateAccountSettingsAssignmentOptions
containing the options for the call- Returns:
- a
ServiceCall
with a result of typeTemplateAssignmentResponse
-
getAccountSettingsAssignment
public com.ibm.cloud.sdk.core.http.ServiceCall<TemplateAssignmentResponse> getAccountSettingsAssignment(GetAccountSettingsAssignmentOptions getAccountSettingsAssignmentOptions)
Get assignment. Get an assigment for an account settings template.- Parameters:
getAccountSettingsAssignmentOptions
- theGetAccountSettingsAssignmentOptions
containing the options for the call- Returns:
- a
ServiceCall
with a result of typeTemplateAssignmentResponse
-
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
- theDeleteAccountSettingsAssignmentOptions
containing the options for the call- Returns:
- a
ServiceCall
with a result of typeExceptionResponse
-
updateAccountSettingsAssignment
public com.ibm.cloud.sdk.core.http.ServiceCall<TemplateAssignmentResponse> updateAccountSettingsAssignment(UpdateAccountSettingsAssignmentOptions updateAccountSettingsAssignmentOptions)
Update assignment. Update an account settings assignment. Call this method to retry failed assignments or migrate the settings in child accounts to a new version.- Parameters:
updateAccountSettingsAssignmentOptions
- theUpdateAccountSettingsAssignmentOptions
containing the options for the call- Returns:
- a
ServiceCall
with a result of typeTemplateAssignmentResponse
-
listAccountSettingsTemplates
public com.ibm.cloud.sdk.core.http.ServiceCall<AccountSettingsTemplateList> listAccountSettingsTemplates(ListAccountSettingsTemplatesOptions listAccountSettingsTemplatesOptions)
List account settings templates. List account settings templates in an enterprise account.- Parameters:
listAccountSettingsTemplatesOptions
- theListAccountSettingsTemplatesOptions
containing the options for the call- Returns:
- a
ServiceCall
with a result of typeAccountSettingsTemplateList
-
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 typeAccountSettingsTemplateList
-
createAccountSettingsTemplate
public com.ibm.cloud.sdk.core.http.ServiceCall<AccountSettingsTemplateResponse> createAccountSettingsTemplate(CreateAccountSettingsTemplateOptions createAccountSettingsTemplateOptions)
Create an account settings template. Create a new account settings template in an enterprise account.- Parameters:
createAccountSettingsTemplateOptions
- theCreateAccountSettingsTemplateOptions
containing the options for the call- Returns:
- a
ServiceCall
with a result of typeAccountSettingsTemplateResponse
-
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 typeAccountSettingsTemplateResponse
-
getLatestAccountSettingsTemplateVersion
public com.ibm.cloud.sdk.core.http.ServiceCall<AccountSettingsTemplateResponse> getLatestAccountSettingsTemplateVersion(GetLatestAccountSettingsTemplateVersionOptions getLatestAccountSettingsTemplateVersionOptions)
Get latest version of an account settings template. Get the latest version of a specific account settings template in an enterprise account.- Parameters:
getLatestAccountSettingsTemplateVersionOptions
- theGetLatestAccountSettingsTemplateVersionOptions
containing the options for the call- Returns:
- a
ServiceCall
with a result of typeAccountSettingsTemplateResponse
-
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
- theDeleteAllVersionsOfAccountSettingsTemplateOptions
containing the options for the call- Returns:
- a
ServiceCall
with a void result
-
listVersionsOfAccountSettingsTemplate
public com.ibm.cloud.sdk.core.http.ServiceCall<AccountSettingsTemplateList> listVersionsOfAccountSettingsTemplate(ListVersionsOfAccountSettingsTemplateOptions listVersionsOfAccountSettingsTemplateOptions)
List account settings template versions. List the versions of a specific account settings template in an enterprise account.- Parameters:
listVersionsOfAccountSettingsTemplateOptions
- theListVersionsOfAccountSettingsTemplateOptions
containing the options for the call- Returns:
- a
ServiceCall
with a result of typeAccountSettingsTemplateList
-
createAccountSettingsTemplateVersion
public com.ibm.cloud.sdk.core.http.ServiceCall<AccountSettingsTemplateResponse> createAccountSettingsTemplateVersion(CreateAccountSettingsTemplateVersionOptions createAccountSettingsTemplateVersionOptions)
Create a new version of an account settings template. Create a new version of an account settings template in an Enterprise Account.- Parameters:
createAccountSettingsTemplateVersionOptions
- theCreateAccountSettingsTemplateVersionOptions
containing the options for the call- Returns:
- a
ServiceCall
with a result of typeAccountSettingsTemplateResponse
-
getAccountSettingsTemplateVersion
public com.ibm.cloud.sdk.core.http.ServiceCall<AccountSettingsTemplateResponse> getAccountSettingsTemplateVersion(GetAccountSettingsTemplateVersionOptions getAccountSettingsTemplateVersionOptions)
Get version of an account settings template. Get a specific version of an account settings template in an Enterprise Account.- Parameters:
getAccountSettingsTemplateVersionOptions
- theGetAccountSettingsTemplateVersionOptions
containing the options for the call- Returns:
- a
ServiceCall
with a result of typeAccountSettingsTemplateResponse
-
updateAccountSettingsTemplateVersion
public com.ibm.cloud.sdk.core.http.ServiceCall<AccountSettingsTemplateResponse> updateAccountSettingsTemplateVersion(UpdateAccountSettingsTemplateVersionOptions updateAccountSettingsTemplateVersionOptions)
Update version of an account settings template. Update a specific version of an account settings template in an Enterprise Account.- Parameters:
updateAccountSettingsTemplateVersionOptions
- theUpdateAccountSettingsTemplateVersionOptions
containing the options for the call- Returns:
- a
ServiceCall
with a result of typeAccountSettingsTemplateResponse
-
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
- theDeleteAccountSettingsTemplateVersionOptions
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
- theCommitAccountSettingsTemplateOptions
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
- theCreateReportOptions
containing the options for the call- Returns:
- a
ServiceCall
with a result of typeReportReference
-
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
- theGetReportOptions
containing the options for the call- Returns:
- a
ServiceCall
with a result of typeReport
-
listTrustedProfileAssignments
public com.ibm.cloud.sdk.core.http.ServiceCall<TemplateAssignmentListResponse> listTrustedProfileAssignments(ListTrustedProfileAssignmentsOptions listTrustedProfileAssignmentsOptions)
List assignments. List trusted profile template assignments.- Parameters:
listTrustedProfileAssignmentsOptions
- theListTrustedProfileAssignmentsOptions
containing the options for the call- Returns:
- a
ServiceCall
with a result of typeTemplateAssignmentListResponse
-
listTrustedProfileAssignments
public com.ibm.cloud.sdk.core.http.ServiceCall<TemplateAssignmentListResponse> listTrustedProfileAssignments()
List assignments. List trusted profile template assignments.- Returns:
- a
ServiceCall
with a result of typeTemplateAssignmentListResponse
-
createTrustedProfileAssignment
public com.ibm.cloud.sdk.core.http.ServiceCall<TemplateAssignmentResponse> createTrustedProfileAssignment(CreateTrustedProfileAssignmentOptions createTrustedProfileAssignmentOptions)
Create assignment. Create an assigment for a trusted profile template.- Parameters:
createTrustedProfileAssignmentOptions
- theCreateTrustedProfileAssignmentOptions
containing the options for the call- Returns:
- a
ServiceCall
with a result of typeTemplateAssignmentResponse
-
getTrustedProfileAssignment
public com.ibm.cloud.sdk.core.http.ServiceCall<TemplateAssignmentResponse> getTrustedProfileAssignment(GetTrustedProfileAssignmentOptions getTrustedProfileAssignmentOptions)
Get assignment. Get an assigment for a trusted profile template.- Parameters:
getTrustedProfileAssignmentOptions
- theGetTrustedProfileAssignmentOptions
containing the options for the call- Returns:
- a
ServiceCall
with a result of typeTemplateAssignmentResponse
-
deleteTrustedProfileAssignment
public com.ibm.cloud.sdk.core.http.ServiceCall<ExceptionResponse> deleteTrustedProfileAssignment(DeleteTrustedProfileAssignmentOptions deleteTrustedProfileAssignmentOptions)
Delete assignment. Delete a trusted profile assignment. This removes any IAM resources created by this assignment in child accounts.- Parameters:
deleteTrustedProfileAssignmentOptions
- theDeleteTrustedProfileAssignmentOptions
containing the options for the call- Returns:
- a
ServiceCall
with a result of typeExceptionResponse
-
updateTrustedProfileAssignment
public com.ibm.cloud.sdk.core.http.ServiceCall<TemplateAssignmentResponse> updateTrustedProfileAssignment(UpdateTrustedProfileAssignmentOptions updateTrustedProfileAssignmentOptions)
Update assignment. Update a trusted profile assignment. Call this method to retry failed assignments or migrate the trusted profile in child accounts to a new version.- Parameters:
updateTrustedProfileAssignmentOptions
- theUpdateTrustedProfileAssignmentOptions
containing the options for the call- Returns:
- a
ServiceCall
with a result of typeTemplateAssignmentResponse
-
listProfileTemplates
public com.ibm.cloud.sdk.core.http.ServiceCall<TrustedProfileTemplateList> listProfileTemplates(ListProfileTemplatesOptions listProfileTemplatesOptions)
List trusted profile templates. List the trusted profile templates in an enterprise account.- Parameters:
listProfileTemplatesOptions
- theListProfileTemplatesOptions
containing the options for the call- Returns:
- a
ServiceCall
with a result of typeTrustedProfileTemplateList
-
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 typeTrustedProfileTemplateList
-
createProfileTemplate
public com.ibm.cloud.sdk.core.http.ServiceCall<TrustedProfileTemplateResponse> createProfileTemplate(CreateProfileTemplateOptions createProfileTemplateOptions)
Create a trusted profile template. Create a new trusted profile template in an enterprise account.- Parameters:
createProfileTemplateOptions
- theCreateProfileTemplateOptions
containing the options for the call- Returns:
- a
ServiceCall
with a result of typeTrustedProfileTemplateResponse
-
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 typeTrustedProfileTemplateResponse
-
getLatestProfileTemplateVersion
public com.ibm.cloud.sdk.core.http.ServiceCall<TrustedProfileTemplateResponse> getLatestProfileTemplateVersion(GetLatestProfileTemplateVersionOptions getLatestProfileTemplateVersionOptions)
Get latest version of a trusted profile template. Get the latest version of a trusted profile template in an enterprise account.- Parameters:
getLatestProfileTemplateVersionOptions
- theGetLatestProfileTemplateVersionOptions
containing the options for the call- Returns:
- a
ServiceCall
with a result of typeTrustedProfileTemplateResponse
-
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
- theDeleteAllVersionsOfProfileTemplateOptions
containing the options for the call- Returns:
- a
ServiceCall
with a void result
-
listVersionsOfProfileTemplate
public com.ibm.cloud.sdk.core.http.ServiceCall<TrustedProfileTemplateList> listVersionsOfProfileTemplate(ListVersionsOfProfileTemplateOptions listVersionsOfProfileTemplateOptions)
List trusted profile template versions. List the versions of a trusted profile template in an enterprise account.- Parameters:
listVersionsOfProfileTemplateOptions
- theListVersionsOfProfileTemplateOptions
containing the options for the call- Returns:
- a
ServiceCall
with a result of typeTrustedProfileTemplateList
-
createProfileTemplateVersion
public com.ibm.cloud.sdk.core.http.ServiceCall<TrustedProfileTemplateResponse> createProfileTemplateVersion(CreateProfileTemplateVersionOptions createProfileTemplateVersionOptions)
Create new version of a trusted profile template. Create a new version of a trusted profile template in an enterprise account.- Parameters:
createProfileTemplateVersionOptions
- theCreateProfileTemplateVersionOptions
containing the options for the call- Returns:
- a
ServiceCall
with a result of typeTrustedProfileTemplateResponse
-
getProfileTemplateVersion
public com.ibm.cloud.sdk.core.http.ServiceCall<TrustedProfileTemplateResponse> getProfileTemplateVersion(GetProfileTemplateVersionOptions getProfileTemplateVersionOptions)
Get version of trusted profile template. Get a specific version of a trusted profile template in an enterprise account.- Parameters:
getProfileTemplateVersionOptions
- theGetProfileTemplateVersionOptions
containing the options for the call- Returns:
- a
ServiceCall
with a result of typeTrustedProfileTemplateResponse
-
updateProfileTemplateVersion
public com.ibm.cloud.sdk.core.http.ServiceCall<TrustedProfileTemplateResponse> updateProfileTemplateVersion(UpdateProfileTemplateVersionOptions updateProfileTemplateVersionOptions)
Update version of trusted profile template. Update a specific version of a trusted profile template in an enterprise account.- Parameters:
updateProfileTemplateVersionOptions
- theUpdateProfileTemplateVersionOptions
containing the options for the call- Returns:
- a
ServiceCall
with a result of typeTrustedProfileTemplateResponse
-
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
- theDeleteProfileTemplateVersionOptions
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
- theCommitProfileTemplateOptions
containing the options for the call- Returns:
- a
ServiceCall
with a void result
-
-