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

Class SetProfileIdentityOptions

java.lang.Object

com.ibm.cloud.sdk.core.service.model.GenericModel

com.ibm.cloud.platform_services.iam_identity.v1.model.SetProfileIdentityOptions

All Implemented Interfaces:

com.ibm.cloud.sdk.core.service.model.ObjectModel

public class SetProfileIdentityOptions
extends com.ibm.cloud.sdk.core.service.model.GenericModel

The setProfileIdentity options.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	SetProfileIdentityOptions.Builder	Builder.
static interface	SetProfileIdentityOptions.IdentityType	Type of the identity.
static interface	SetProfileIdentityOptions.Type	Type of the identity.

Method Summary

Modifier and Type	Method	Description
java.util.List<java.lang.String>	accounts()	Gets the accounts.
java.lang.String	description()	Gets the description.
java.lang.String	identifier()	Gets the identifier.
java.lang.String	identityType()	Gets the identityType.
SetProfileIdentityOptions.Builder	newBuilder()	New builder.
java.lang.String	profileId()	Gets the profileId.
java.lang.String	type()	Gets the type.

Methods inherited from class com.ibm.cloud.sdk.core.service.model.GenericModel

equals, hashCode, toString

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Method Detail

newBuilder

public SetProfileIdentityOptions.Builder newBuilder()

New builder.

Returns:

a SetProfileIdentityOptions builder

profileId

public java.lang.String profileId()

Gets the profileId. ID of the trusted profile.

Returns:

the profileId

identityType

public java.lang.String identityType()

Gets the identityType. Type of the identity.

Returns:

the identityType

identifier

public java.lang.String identifier()

Gets the identifier. Identifier of the identity that can assume the trusted profiles. This can be a user identifier (IAM id), serviceid or crn. Internally it uses account id of the service id for the identifier 'serviceid' and for the identifier 'crn' it uses account id contained in the CRN.

Returns:

the identifier

type

public java.lang.String type()

Gets the type. Type of the identity.

Returns:

the type

accounts

public java.util.List<java.lang.String> accounts()

Gets the accounts. Only valid for the type user. Accounts from which a user can assume the trusted profile.

Returns:

the accounts

description

public java.lang.String description()

Gets the description. Description of the identity that can assume the trusted profile. This is optional field for all the types of identities. When this field is not set for the identity type 'serviceid' then the description of the service id is used. Description is recommended for the identity type 'crn' E.g. 'Instance 1234 of IBM Cloud Service project'.

Returns:

the description