@Generated(value="OracleSDKGenerator", comments="API Version: 20160918") public class IdentityProvider extends ExplicitlySetBmcModel
The resulting base object when you add an identity provider to your tenancy. A
Saml2IdentityProvider
is a specific type of IdentityProvider that supports the SAML 2.0 protocol. Each
IdentityProvider object has its own OCID. For more information, see
Identity Providers and Federation.
To use any of the API operations, you must be authorized in an IAM policy. If you're not authorized, talk to an administrator. If you're an administrator who needs to write policies to give users access, see [Get Started with Policies](https://docs.cloud.oracle.com/Content/Identity/policiesgs/get-started-with-policies.htm).
Warning:** Oracle recommends that you avoid using any confidential information when you supply string
values using the API.
Note: Objects should always be created or deserialized using the Builder. This model distinguishes fields
that are null because they are unset from fields that are explicitly set to null. This is done in
the setter methods of the Builder, which maintain a set of all explicitly set fields called
ExplicitlySetBmcModel.__explicitlySet__. The hashCode() and equals(Object) methods are implemented to take
ExplicitlySetBmcModel.__explicitlySet__ into account. The constructor, on the other hand, does not set ExplicitlySetBmcModel.__explicitlySet__
(since the constructor cannot distinguish explicit null from unset null).
| Modifier and Type | Class and Description |
|---|---|
static class |
IdentityProvider.LifecycleState
The current state.
|
| Modifier | Constructor and Description |
|---|---|
protected |
IdentityProvider(String id,
String compartmentId,
String name,
String description,
String productType,
Date timeCreated,
IdentityProvider.LifecycleState lifecycleState,
Long inactiveStatus,
Map<String,String> freeformTags,
Map<String,Map<String,Object>> definedTags)
Deprecated.
|
| Modifier and Type | Method and Description |
|---|---|
boolean |
equals(Object o) |
String |
getCompartmentId()
The OCID of the tenancy containing the
IdentityProvider. |
Map<String,Map<String,Object>> |
getDefinedTags()
Defined tags for this resource.
|
String |
getDescription()
The description you assign to the
IdentityProvider during creation. |
Map<String,String> |
getFreeformTags()
Free-form tags for this resource.
|
String |
getId()
The OCID of the
IdentityProvider. |
Long |
getInactiveStatus()
The detailed status of INACTIVE lifecycleState.
|
IdentityProvider.LifecycleState |
getLifecycleState()
The current state.
|
String |
getName()
The name you assign to the
IdentityProvider during creation. |
String |
getProductType()
The identity provider service or product.
|
Date |
getTimeCreated()
Date and time the
IdentityProvider was created, in the format defined by RFC3339. |
int |
hashCode() |
String |
toString() |
String |
toString(boolean includeByteArrayContents)
Return a string representation of the object.
|
markPropertyAsExplicitlySet, wasPropertyExplicitlySet@Deprecated @ConstructorProperties(value={"id","compartmentId","name","description","productType","timeCreated","lifecycleState","inactiveStatus","freeformTags","definedTags"}) protected IdentityProvider(String id, String compartmentId, String name, String description, String productType, Date timeCreated, IdentityProvider.LifecycleState lifecycleState, Long inactiveStatus, Map<String,String> freeformTags, Map<String,Map<String,Object>> definedTags)
public String getId()
The OCID of the IdentityProvider.
public String getCompartmentId()
The OCID of the tenancy containing the IdentityProvider.
public String getName()
The name you assign to the IdentityProvider during creation. The name
must be unique across all IdentityProvider objects in the tenancy and
cannot be changed. This is the name federated users see when choosing
which identity provider to use when signing in to the Oracle Cloud Infrastructure
Console.
public String getDescription()
The description you assign to the IdentityProvider during creation. Does
not have to be unique, and it’s changeable.
public String getProductType()
The identity provider service or product. Supported identity providers are Oracle Identity Cloud Service (IDCS) and Microsoft Active Directory Federation Services (ADFS).
Allowed values are:
- ADFS
- IDCS
Example: IDCS
public Date getTimeCreated()
Date and time the IdentityProvider was created, in the format defined by RFC3339.
Example: 2016-08-25T21:10:29.600Z
public IdentityProvider.LifecycleState getLifecycleState()
The current state. After creating an IdentityProvider, make sure its
lifecycleState changes from CREATING to ACTIVE before using it.
public Long getInactiveStatus()
The detailed status of INACTIVE lifecycleState.
public Map<String,String> getFreeformTags()
Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace.
For more information, see Resource Tags.
Example: {"Department": "Finance"}
public Map<String,Map<String,Object>> getDefinedTags()
Defined tags for this resource. Each key is predefined and scoped to a namespace.
For more information, see Resource Tags.
Example: {"Operations": {"CostCenter": "42"}}
public String toString()
toString in class ExplicitlySetBmcModelpublic String toString(boolean includeByteArrayContents)
Return a string representation of the object.
includeByteArrayContents - true to include the full contents of byte arrayspublic boolean equals(Object o)
equals in class ExplicitlySetBmcModelpublic int hashCode()
hashCode in class ExplicitlySetBmcModelCopyright © 2016–2022. All rights reserved.