The identity and technical contract details declared by the specification.
AuthToken
object
An AuthToken is an Oracle-generated token string that you can use to authenticate with third-party APIs that do not support Oracle Cloud Infrastructure's signa…
8 properties
DbCredentialSummary
object
As the name suggests, an DbCredentialSummary object contains information about an DbCredential. The DB credential is used for DB authentication with the [DB Se…
6 properties
UpdatePolicyDetails
object
5 properties
UpdateCustomerSecretKeyDetails
object
1 property
PasswordPolicy
object
Password policy, currently set for the given compartment.
6 properties
UpdateAuthenticationPolicyDetails
object
Update request for authentication policy, describes set of validation rules and their parameters to be updated.
2 properties
UpdateUserDetails
object
5 properties
WorkRequestSummary
object
The work request summary. Tracks the status of the asynchronous operation.
10 properties
3 required
BulkEditTagsResourceTypeCollection
object
The list of resource types that support bulk editing of tags.
1 property
1 required
CreateCompartmentDetails
object
5 properties
3 required
CreateGroupDetails
object
5 properties
3 required
AddLockDetails
object
Request payload to add lock to the resource.
3 properties
1 required
RemoveLockDetails
object
Request payload to remove lock to the resource.
1 property
1 required
ResourceLock
object
Resource locks are used to prevent certain APIs from being called for the resource. A full lock prevents both updating the resource and deleting the resource.…
5 properties
1 required
CreateCustomerSecretKeyDetails
object
1 property
1 required
IdcsDomainServiceStatusDetails
object
IDCS Domain Service Status
1 property
1 required
IdentityProviderGroupSummary
object
A group created in an identity provider that can be mapped to a group in OCI
7 properties
UIPassword
object
A text password that enables a user to sign in to the Console, the user interface for interacting with Oracle Cloud Infrastructure. For more information about…
5 properties
CustomerSecretKey
object
A CustomerSecretKey is an Oracle-provided key for using the Object Storage Service's [Amazon S3 compatible API](/Content/Object/Tasks/s3compatibleapi.htm). The…
8 properties
CreateSwiftPasswordDetails
object
1 property
1 required
BulkEditTagsResourceType
object
2 properties
1 required
OAuth2ClientCredentialSummary
object
User can define Oauth clients in IAM, then use it to generate a token to grant access to app resources.
9 properties
CreateDbCredentialDetails
object
2 properties
2 required
UserCapabilities
object
Properties indicating how the user is allowed to authenticate.
7 properties
MfaTotpDeviceSummary
object
As the name suggests, a MfaTotpDeviceSummary object contains information about a MfaTotpDevice.
7 properties
5 required
AddPolicyLockDetails
object
Request payload to add lock to the resource.
3 properties
1 required
UpdateSwiftPasswordDetails
object
1 property
TaggingWorkRequest
object
The asynchronous API request does not take effect immediately. This request spawns an asynchronous workflow to fulfill the request. WorkRequest objects provide…
9 properties
3 required
NetworkSourcesSummary
object
A network source specifies a list of source IP addresses that are allowed to make authorization requests. Use the network source in policy statements to restri…
11 properties
6 required
AddUserToGroupDetails
object
2 properties
2 required
UserGroupMembership
object
An object that represents the membership of a user in a group. When you add a user to a group, the result is a UserGroupMembership with its own OCID. To remove…
7 properties
6 required
MfaTotpToken
object
Totp token for MFA
1 property
StandardTagDefinitionTemplate
object
The template of the tag definition. This object includes necessary details to create the provided standard tag definition.
6 properties
4 required
FaultDomain
object
A Fault Domain is a logical grouping of hardware and infrastructure within an Availability Domain that can become unavailable in its entirety either due to har…
4 properties
DomainSummary
object
(For tenancies that support identity domains) As the name suggests, a DomainSummary object contains information about a Domain.
16 properties
13 required
CreateAuthTokenDetails
object
1 property
1 required
SmtpCredentialSummary
object
As the name suggests, an SmtpCredentialSummary object contains information about an SmtpCredential. The SMTP credential is used for SMTP authentication with th…
8 properties
CustomerSecretKeySummary
object
As the name suggests, a CustomerSecretKeySummary object contains information about a CustomerSecretKey. A CustomerSecretKey is an Oracle-provided key for using…
7 properties
IamWorkRequestResource
object
(For tenancies that support identity domains) A IAM work request resource entry.
4 properties
3 required
BulkDeleteTagsDetails
object
Properties for deleting tags in bulk
1 property
1 required
WorkRequestError
object
The error entity.
3 properties
2 required
BulkDeleteResourcesDetails
object
1 property
1 required
UpdateIdentityProviderDetails
object
4 properties
1 required
RegionSubscription
object
An object that represents your tenancy's access to a particular region (i.e., a subscription), the status of that access, and whether that region is the home r…
4 properties
4 required
Tag
object
A tag definition that belongs to a specific tag namespace. "Defined tags" must be set up in your tenancy before you can apply them to resources. For more infor…
14 properties
8 required
FullyQualifiedScope
object
2 properties
2 required
EnableReplicationToRegionDetails
object
(For tenancies that support identity domains) Identity domain replication request packet.
1 property
IdpGroupMapping
object
A mapping between a single group defined by the identity provider (IdP) you're federating with and a single IAM Service [group](/en/identity/20160918/Group/) i…
8 properties
7 required
TaggingWorkRequestErrorSummary
object
The error entity.
3 properties
2 required
CreatePolicyDetails
object
8 properties
4 required
CreateOAuth2ClientCredentialDetails
object
3 properties
3 required
StandardTagNamespaceTemplateSummary
object
The template of the standard tag namespace. This object includes necessary details to create the provided standard tag namespace.
3 properties
3 required
UpdateTagDetails
object
6 properties
CreateDynamicGroupDetails
object
Properties for creating a dynamic group.
6 properties
4 required
ChangeTagNamespaceCompartmentDetail
object
Details of the compartment the resource is being moved to.
1 property
1 required
CreateTagDefaultDetails
object
5 properties
3 required
CreateDomainDetails
object
(For tenancies that support identity domains) Details for creating an identity domain.
14 properties
5 required
TagDefaultSummary
object
Summary information for the specified tag default.
10 properties
8 required
UpdateGroupDetails
object
3 properties
WorkRequestLogEntry
object
The log entity.
2 properties
1 required
UpdateOAuth2ClientCredentialDetails
object
3 properties
3 required
CreateSmtpCredentialDetails
object
1 property
1 required
IdentityProvider
object
The resulting base object when you add an identity provider to your tenancy. A [Saml2IdentityProvider](/en/identity/20160918/Saml2IdentityProvider/) is a speci…
11 properties
8 required
IamWorkRequestErrorSummary
object
(For tenancies that support identity domains) An error encountered while executing an operation that is tracked by a IAM work request.
3 properties
3 required
Tenancy
object
The root compartment that contains all of your organization's compartments and other Oracle Cloud Infrastructure cloud resources. When you sign up for Oracle C…
7 properties
Policy
object
A document that specifies the type of access a group has to the resources in a compartment. For information about policies and other IAM Service components, se…
12 properties
7 required
ChangeDomainCompartmentDetails
object
1 property
1 required
BulkMoveResourcesDetails
object
2 properties
2 required
Compartment
object
A collection of related resources. Compartments are a fundamental component of Oracle Cloud Infrastructure for organizing and isolating your cloud resources. Y…
10 properties
6 required
SmtpCredential
object
Simple Mail Transfer Protocol (SMTP) credentials are needed to send email through Email Delivery. The SMTP credentials are used for SMTP authentication with th…
9 properties
CreateIdentityProviderDetails
object
7 properties
5 required
CreateTagNamespaceDetails
object
6 properties
3 required
IamWorkRequest
object
(For tenancies that support identity domains) An IAM work request object that allows users to track the status of asynchronous API requests.
9 properties
3 required
UpdateIdpGroupMappingDetails
object
2 properties
BulkEditResource
object
3 properties
2 required
StandardTagNamespaceTemplate
object
The template of the standard tag namespace. This object includes necessary details to create the provided standard tag namespace.
4 properties
4 required
Region
object
A localized geographic area, such as Phoenix, AZ. Oracle Cloud Infrastructure is hosted in regions and Availability Domains. A region is composed of several Av…
2 properties
TagDefault
object
Tag defaults let you specify a default tag (tagnamespace.tag="value") to apply to all resource types in a specified compartment. The tag default is applied at…
10 properties
8 required
ImportStandardTagsDetails
object
2 properties
2 required
TagNamespace
object
A managed container for defined tags. A tag namespace is unique in a tenancy. For more information, see [Managing Tags and Tag Namespaces](/Content/Tagging/Tas…
11 properties
6 required
CreateNetworkSourceDetails
object
Properties for creating a network source object.
8 properties
3 required
SwiftPassword
object
Deprecated. Use [AuthToken](/en/identity/20160918/AuthToken/) instead. Swift is the OpenStack object storage service. A SwiftPassword is an Oracle-provided pas…
8 properties
WorkRequest
object
The asynchronous API request does not take effect immediately. This request spawns an asynchronous workflow to fulfill the request. WorkRequest objects provide…
11 properties
3 required
UpdateUserCapabilitiesDetails
object
7 properties
UpdateCompartmentDetails
object
4 properties
BulkActionResourceType
object
2 properties
1 required
ReplicatedRegionDetails
object
(For tenancies that support identity domains) Properties for a region where a replica for the identity domain exists.
4 properties
DynamicGroup
object
A dynamic group defines a matching rule. Every bare metal or virtual machine instance is deployed with an instance certificate. The certificate contains metada…
10 properties
7 required
NetworkSources
object
A network source specifies a list of source IP addresses that are allowed to make authorization requests. Use the network source in policy statements to restri…
12 properties
6 required
NetworkPolicy
object
Network policy, which consists of a list of network source IDs.
1 property
UpdateSmtpCredentialDetails
object
1 property
BulkActionResource
object
The bulk action resource entity.
3 properties
2 required
BaseTagDefinitionValidator
object
Validates a definedTag value. Each validator performs validation steps in addition to the standard validation for definedTag values. For more information, see…
1 property
1 required
RemovePolicyLockDetails
object
Request payload to remove lock to the resource.
1 property
1 required
CreateApiKeyDetails
object
1 property
1 required
ScimClientCredentials
object
The OAuth2 client credentials.
2 properties
TaggingWorkRequestLogSummary
object
The log entity.
2 properties
1 required
IamWorkRequestLogSummary
object
(For tenancies that support identity domains) The log entity for a IAM work request.
2 properties
1 required
UIPasswordInformation
object
Information about the UIPassword, which is a text password that enables a user to sign in to the Console, the user interface for interacting with Oracle Cloud…
3 properties
User
object
An individual employee or system that needs to manage or use your company's Oracle Cloud Infrastructure resources. Users might need to launch instances, manage…
18 properties
7 required
MfaTotpDevice
object
Users can enable multi-factor authentication (MFA) for their own user accounts. After MFA is enabled, the user is prompted for a time-based one-time password (…
8 properties
6 required
WorkRequestResource
object
The resource entity.
4 properties
3 required
MoveCompartmentDetails
object
1 property
1 required
UpdateDomainDetails
object
(For tenancies that support identity domains) Update identity domain details.
5 properties
TagNamespaceSummary
object
A container for defined tags.
11 properties
ResourceLockPolicy
object
Resource locks are used to prevent certain APIs from being called for the resource. A full lock prevents both updating the resource and deleting the resource.…
6 properties
1 required
CreateUserDetails
object
6 properties
3 required
BulkEditTagsDetails
object
3 properties
3 required
BulkActionResourceTypeCollection
object
Collection of resource-types supported by a compartment bulk action.
1 property
1 required
AvailabilityDomain
object
One or more isolated, fault-tolerant Oracle data centers that host cloud resources such as instances, volumes, and subnets. A region contains several Availabil…
3 properties
UpdateNetworkSourceDetails
object
6 properties
UpdateDynamicGroupDetails
object
Properties for updating a dynamic group.
4 properties
AllowedDomainLicenseTypeSummary
object
(For tenancies that support identity domains) The 'AllowedDomainLicenseTypeSummary' object contains information about the license type of the identity domain.
3 properties
3 required
ChangeDomainLicenseTypeDetails
object
(For tenancies that support identity domains) Details for updating the license type of the identity domain.
1 property
UpdateAuthTokenDetails
object
1 property
AuthenticationPolicy
object
Authentication policy, currently set for the given compartment.
3 properties
IamWorkRequestSummary
object
(For tenancies that support identity domains) The IAM work request summary. Tracks the status of asynchronous operations.
9 properties
3 required
TagSummary
object
A tag definition that belongs to a specific tag namespace.
11 properties
DbCredential
object
Database credentials are needed for onboarding cloud database to identity. The DB credentials are used for DB authentication with the service.
6 properties
OAuth2ClientCredential
object
User can define Oauth clients in IAM, then use it to generate a token to grant access to app resources.
10 properties
UpdateTagDefaultDetails
object
2 properties
1 required
CreateRegionSubscriptionDetails
object
1 property
1 required
ApiKey
object
A PEM-format RSA credential for securing requests to the Oracle Cloud Infrastructure REST API. Also known as an API signing key. Specifically, this is the publ…
7 properties
BulkEditOperationDetails
object
2 properties
2 required
Error
object
2 properties
2 required
Group
object
A collection of users who all need the same type of access to a particular set of resources or compartment. For conceptual information about groups and other I…
9 properties
6 required
UpdateTagNamespaceDetails
object
4 properties
CreateTagDetails
object
6 properties
2 required
TaggingWorkRequestSummary
object
The work request summary. Tracks the status of the asynchronous operation.
9 properties
3 required
CreateIdpGroupMappingDetails
object
2 properties
2 required
UpdateStateDetails
object
1 property
Domain
object
(For tenancies that support identity domains) Properties for an identity domain. An identity domain is used to manage users and groups, integration standards,…
16 properties
13 required
The full machine-readable OpenAPI contract behind this narrative.
Other APIs Oracle publishes across the network.