Identity actions

Every Identity action

• OCI Identity: Activate MFA TOTP DeviceActivate a user's MFA TOTP device by submitting the 6-digit code from their authenticator app: the device must be activated before it can be used for sign-in.
• OCI Identity: Add User to GroupAdd an Oracle Cloud IAM user to a group: creating the membership that grants the user every policy the group is named in. Returns the membership OCID (use it to remove the user later).
• OCI Identity: Create Auth TokenCreate an auth token for an Oracle Cloud IAM user: a bearer credential for services that use token auth. The token value is returned ONCE here and never shown again, so capture it now.
• OCI Identity: Create CompartmentCreate an Oracle Cloud compartment under a parent (or the tenancy root): the container that groups and isolates resources for access control and billing.
• OCI Identity: Create Customer Secret KeyCreate a customer secret key for an Oracle Cloud IAM user: an access-key/secret-key pair for Object Storage's Amazon S3-compatible API. The secret key value is returned ONCE here and never shown again, so capture it now.
• OCI Identity: Create DB CredentialCreate a database credential for an Oracle Cloud IAM user: used to authenticate a cloud database to Identity. You supply the password here (it is not generated), so store it yourself; OCI never returns it again.
• OCI Identity: Create Dynamic GroupCreate an Oracle Cloud dynamic group: members are resources (compute instances, functions…) matched by a rule, so policies can grant permissions to workloads without static credentials.
• OCI Identity: Create GroupCreate an Oracle Cloud IAM group in the tenancy: a named set of users that policies grant permissions to. Add users with Add User to Group.
• OCI Identity: Create Identity ProviderCreate a SAML2 federation identity provider in an Oracle Cloud tenancy: trust an external IdP (IDCS or ADFS) by supplying its SAML metadata XML so its users can federate in.
• OCI Identity: Create IdP Group MappingMap an Oracle Cloud identity provider (IdP) group to an IAM Service group, so federated users in that IdP group inherit the IAM group's access.
• OCI Identity: Create MFA TOTP DeviceRegister a multi-factor-authentication TOTP device for an Oracle Cloud IAM user. This starts enrolment: the device comes back in the CREATING state: you must then generate its seed and activate it (with a TOTP code) to finish, and MFA registration ultimately requires the Console.
• OCI Identity: Create Network SourceCreate an Oracle Cloud IAM network source: a named list of allowed public IPs/CIDR ranges you can reference in policy statements to restrict access by source IP.
• OCI Identity: Create OAuth Client CredentialCreate an OAuth 2.0 client credential for an Oracle Cloud IAM user: a client-id/secret pair for the OAuth client-credentials grant. The secret (password) is returned ONCE here and never shown again, so capture it now.
• OCI Identity: Create or Reset UI PasswordCreate or reset an Oracle Cloud IAM user's Console (UI) sign-in password. A new one-time password is generated and returned ONCE here: it is never shown again, so capture it now. If the user already has a password, this resets it.
• OCI Identity: Create PolicyCreate an Oracle Cloud IAM policy in a compartment: one statement per line, e.g. "Allow group Admins to manage all-resources in tenancy". Statements are what actually grant access.
• OCI Identity: Create SMTP CredentialCreate an SMTP credential for an Oracle Cloud IAM user: an Oracle-generated username/password pair for sending mail through Email Delivery. The password is returned ONCE here and never shown again, so capture it now.
• OCI Identity: Create Swift PasswordCreate a Swift password for an Oracle Cloud IAM user: an Oracle-generated credential for Swift-client access to Object Storage. The password value is returned ONCE here and never shown again, so capture it now. (Swift passwords are deprecated in favour of auth tokens.)
• OCI Identity: Create Tag KeyCreate a defined tag key inside an Oracle Cloud tag namespace. The name is unique within the namespace and cannot be changed later; enable cost tracking to have it appear on cost reports.
• OCI Identity: Create Tag NamespaceCreate an Oracle Cloud tag namespace: the container that holds defined tag keys. The name is unique in the tenancy and cannot be changed later.
• OCI Identity: Create UserCreate an Oracle Cloud IAM user in the tenancy: the login/principal that policies grant access to. Add it to groups to give it permissions.
• OCI Identity: Delete API KeyRemove an API signing key from an Oracle Cloud IAM user, identified by the target user's OCID and the key's fingerprint. This is permanent: the key can no longer sign requests.
• OCI Identity: Delete Auth TokenDelete an auth token from an Oracle Cloud IAM user: permanently revokes that bearer credential. Give the user's OCID and the auth token's OCID.
• OCI Identity: Delete CompartmentDelete an Oracle Cloud compartment by OCID. The compartment must be empty first. Asynchronous: returns a work-request id; the compartment moves to DELETING then DELETED.
• OCI Identity: Delete Customer Secret KeyPermanently delete a customer secret key (an S3-compatible Access Key / Secret Key pair) from an Oracle Cloud IAM user. Synchronous.
• OCI Identity: Delete DB CredentialPermanently delete a database (DB) credential from an Oracle Cloud IAM user. Synchronous.
• OCI Identity: Delete Dynamic GroupPermanently delete an Oracle Cloud IAM dynamic group by OCID. Any policies that grant it access stop matching once it is gone. Synchronous.
• OCI Identity: Delete GroupPermanently delete an Oracle Cloud IAM group by OCID. Remove its members first if OCI reports it is not empty. Synchronous.
• OCI Identity: Delete Identity ProviderPermanently delete an Oracle Cloud IAM identity provider by OCID. Remove its group mappings first if OCI reports they still exist. Synchronous.
• OCI Identity: Delete IdP Group MappingDelete a single group mapping (the link between an identity-provider group and an Oracle Cloud IAM group) by its OCID. Synchronous.
• OCI Identity: Delete MFA TOTP DeviceDelete an MFA TOTP device from an Oracle Cloud IAM user: removes that authenticator so the user must re-enrol to use MFA again. Give the user's OCID and the MFA TOTP device's OCID.
• OCI Identity: Delete Network SourcePermanently delete an Oracle Cloud IAM network source by OCID. Detach it from any policies that reference it first if OCI reports it is in use. Synchronous.
• OCI Identity: Delete OAuth Client CredentialPermanently delete an OAuth 2.0 client credential belonging to an Oracle Cloud IAM user, revoking its ability to obtain access tokens. Synchronous.
• OCI Identity: Delete PolicyPermanently delete an Oracle Cloud IAM policy by OCID: its statements stop granting access immediately. Synchronous.
• OCI Identity: Delete SMTP CredentialPermanently delete an SMTP credential belonging to an Oracle Cloud IAM user, revoking its ability to send mail through the Email Delivery service. Synchronous.
• OCI Identity: Delete Swift PasswordDelete a Swift password from an Oracle Cloud IAM user: permanently revokes that Object Storage Swift/RADOS credential. Give the user's OCID and the Swift password's OCID.
• OCI Identity: Delete Tag KeyDelete a tag key definition from an Oracle Cloud tag namespace, identified by the namespace OCID and the tag name. Asynchronous: returns a work-request id; the tag moves to DELETING then DELETED.
• OCI Identity: Delete Tag NamespaceDelete an Oracle Cloud tag namespace by OCID. It must be retired and empty (no tag definitions) first. Cascade delete is asynchronous: when the service returns a work-request id it is surfaced; otherwise the delete completes synchronously.
• OCI Identity: Delete UserPermanently delete an Oracle Cloud IAM user by OCID. Remove the user from its groups first if OCI reports it is still a member. Synchronous.
• OCI Identity: Get Authentication PolicyFetch the Oracle Cloud IAM authentication policy for a compartment (defaulting to the tenancy): its password complexity rules and the network sources allowed to sign in.
• OCI Identity: Get CompartmentFetch a single Oracle Cloud IAM compartment by OCID: its name, description, parent, accessibility and lifecycle state.
• OCI Identity: Get Dynamic GroupFetch a single Oracle Cloud IAM dynamic group by OCID: its name, description, matching rule and lifecycle state.
• OCI Identity: Get GroupFetch a single Oracle Cloud IAM group by OCID: its name, description, compartment and lifecycle state.
• OCI Identity: Get Group MembershipFetch a single Oracle Cloud IAM user-group membership by OCID: the user, group and compartment it ties together, plus its lifecycle state.
• OCI Identity: Get Identity ProviderFetch a single Oracle Cloud IAM identity provider by OCID: its name, product type, protocol and (for SAML2) metadata/redirect URLs and signing certificate.
• OCI Identity: Get MFA TOTP DeviceFetch a single Oracle Cloud IAM MFA TOTP device by OCID: its lifecycle state, whether it is activated, and its creation/expiry times.
• OCI Identity: Get Network SourceFetch a single Oracle Cloud IAM network source by OCID: its name, description, allowed public IP/CIDR list, VCN source list and lifecycle state.
• OCI Identity: Get PolicyFetch a single Oracle Cloud IAM policy by OCID: its name, description, compartment, statements and lifecycle state.
• OCI Identity: Get Tag KeyFetch a single Oracle Cloud tag key definition by its namespace OCID and tag name: its description, retired flag, cost-tracking flag and lifecycle state.
• OCI Identity: Get Tag NamespaceFetch a single Oracle Cloud tag namespace by OCID: its name, description, compartment, retired flag and lifecycle state.
• OCI Identity: Get TenancyFetch the Oracle Cloud tenancy (the root compartment): its name, description and home-region key.
• OCI Identity: Get UI Password InfoFetch metadata about an Oracle Cloud IAM user's Console (UI) password: its lifecycle state and creation time. This never returns the password itself, only whether one exists and its state.
• OCI Identity: Get UserFetch a single Oracle Cloud IAM user by OCID: its name, description, email, MFA status and lifecycle state.
• OCI Identity: List API KeysList the API signing keys uploaded for an Oracle Cloud IAM user: each key's fingerprint, OCID and lifecycle state.
• OCI Identity: List Auth TokensList the auth tokens belonging to an Oracle Cloud IAM user: their OCID, description, lifecycle state and expiry. The token secret itself is never returned by a list (only on create).
• OCI Identity: List Availability DomainsList the availability domains visible to a compartment (the tenancy): each one's name and OCID. Walks pagination up to a safe cap.
• OCI Identity: List CompartmentsList the Oracle Cloud compartments under a parent compartment (leave blank for the tenancy root). Optionally traverse the full subtree. Walks pagination up to a safe cap.
• OCI Identity: List Customer Secret KeysList the customer secret keys belonging to an Oracle Cloud IAM user (used with Object Storage's S3-compatible API): their OCID, display name, lifecycle state and creation time. The secret key itself is never returned by a list (only on create).
• OCI Identity: List DB CredentialsList the DB credentials belonging to an Oracle Cloud IAM user: their OCID, description, lifecycle state, creation and expiry times. The credential secret itself is never returned by a list (only on create).
• OCI Identity: List Dynamic GroupsList the Oracle Cloud IAM dynamic groups in a compartment (the tenancy), optionally filtered by exact name. Walks pagination up to a safe cap.
• OCI Identity: List Group MembershipsList the Oracle Cloud IAM user-group memberships in a compartment (the tenancy), optionally filtered by a user OCID and/or a group OCID. Walks pagination up to a safe cap.
• OCI Identity: List GroupsList the Oracle Cloud IAM groups in a compartment (the tenancy), optionally filtered by exact name. Walks pagination up to a safe cap.
• OCI Identity: List Identity ProvidersList the federated identity providers configured on an Oracle Cloud tenancy for a given federation protocol (e.g. SAML2). Walks pagination up to a safe cap.
• OCI Identity: List IdP Group MappingsList the group mappings for an Oracle Cloud identity provider: each links one federated IdP group to one IAM group. Walks pagination up to a safe cap.
• OCI Identity: List MFA TOTP DevicesList the MFA TOTP (authenticator-app) devices registered for an Oracle Cloud IAM user: each device's OCID, activation flag and lifecycle state. Walks pagination up to a safe cap.
• OCI Identity: List Network SourcesList the Oracle Cloud IAM network sources in a compartment (the tenancy), optionally filtered by exact name: with their allowed public IP/CIDR and VCN source lists. Walks pagination up to a safe cap.
• OCI Identity: List OAuth Client CredentialsList the OAuth 2.0 client credentials belonging to an Oracle Cloud IAM user: their OCID, name, description, scopes, expiry and lifecycle state. The client-secret value is never returned by a list (only once on create).
• OCI Identity: List PoliciesList the Oracle Cloud IAM policies in a compartment (the tenancy), optionally filtered by exact name. Walks pagination up to a safe cap.
• OCI Identity: List Region SubscriptionsList the Oracle Cloud regions this tenancy is subscribed to: each region's key, name, subscription status and whether it is the home region.
• OCI Identity: List RegionsList every Oracle Cloud region in the catalogue: each region's 3-letter key (e.g. LHR) and name (e.g. uk-london-1).
• OCI Identity: List SMTP CredentialsList the SMTP credentials belonging to an Oracle Cloud IAM user: their OCID, SMTP username, description and lifecycle state. The credential password is never returned by a list (only once on create).
• OCI Identity: List Swift PasswordsList the Swift passwords belonging to an Oracle Cloud IAM user: their OCID, description, lifecycle state, creation and expiry times. The password secret itself is never returned by a list (only on create). Swift passwords are deprecated in favour of auth tokens.
• OCI Identity: List Tag KeysList the tag key definitions in an Oracle Cloud tag namespace, optionally filtered by exact name. Walks pagination up to a safe cap.
• OCI Identity: List Tag NamespacesList the Oracle Cloud tag namespaces in a compartment (the tenancy), optionally including those in subcompartments. Walks pagination up to a safe cap.
• OCI Identity: List UsersList the Oracle Cloud IAM users in a compartment (the tenancy), optionally filtered by exact name. Walks pagination up to a safe cap.
• OCI Identity: Move CompartmentMove an Oracle Cloud compartment (and its contents) into a different parent compartment. Asynchronous: returns a work-request id to track the move.
• OCI Identity: Recover CompartmentRecover (un-delete) a previously deleted Oracle Cloud IAM compartment by OCID, returning it to the active state.
• OCI Identity: Remove User from GroupRemove an Oracle Cloud IAM user from a group by deleting the membership: pass the membership OCID from Add User to Group or List Memberships (not the user and group OCIDs). Synchronous.
• OCI Identity: Unblock UserUnblock an Oracle Cloud IAM user that was auto-blocked after repeated failed sign-ins. OCI's state API only supports unblocking: to disable a user, remove their capabilities or delete them.
• OCI Identity: Update Auth TokenChange the description of an existing Oracle Cloud IAM auth token. The token secret is never re-shown: only the description is editable.
• OCI Identity: Update Authentication PolicyUpdate the Oracle Cloud IAM authentication (password) policy for a compartment: minimum length and the character-class requirements. Reads the current policy first and overlays only the fields you set, leaving the rest (including the network policy) untouched.
• OCI Identity: Update CompartmentUpdate an Oracle Cloud compartment's name, description and/or freeform tags: only the fields you supply are changed.
• OCI Identity: Update Dynamic GroupUpdate an Oracle Cloud dynamic group's description, matching rule and/or freeform tags: only the fields you supply are changed.
• OCI Identity: Update GroupUpdate an Oracle Cloud IAM group's description and/or freeform tags. Only the fields you supply are changed; the group name is immutable.
• OCI Identity: Update Network SourceUpdate an Oracle Cloud IAM network source: its description, allowed public IP/CIDR list or services. The IP list and services REPLACE wholesale, so leave one blank to keep the current values (they are re-sent unchanged for you, along with the untouched VCN/virtual source list).
• OCI Identity: Update PolicyUpdate an Oracle Cloud IAM policy: its description, statements or freeform tags. Statements REPLACE the policy wholesale, so leave them blank to keep the current ones (they are re-sent unchanged for you).
• OCI Identity: Update Tag KeyUpdate an Oracle Cloud tag key definition (its description, retired flag or cost-tracking flag) within a tag namespace. Only the fields you supply are changed; the tag name is immutable.
• OCI Identity: Update Tag NamespaceUpdate an Oracle Cloud tag namespace's description and/or retired state: only the fields you supply are changed.
• OCI Identity: Update UserUpdate an Oracle Cloud IAM user's description, email and/or freeform tags: only the fields you supply are changed.
• OCI Identity: Update User CapabilitiesEnable or disable an Oracle Cloud IAM user's credential capabilities (console password, API keys, auth tokens, SMTP/DB/customer-secret/OAuth2 credentials). Only the switches you set are changed; the rest are left as-is.
• OCI Identity: Upload API KeyUpload an API signing key (the PEM RSA public key) for an Oracle Cloud IAM user: the private half stays with the caller. Returns the key's fingerprint. Each user may hold at most three API keys.

Also in Oracle Cloud