swift_passwords

Creates, updates, deletes, gets or lists a swift_passwords resource.

Overview

Name	`swift_passwords`
Type	Resource
Id	`oci.identity.swift_passwords`

Fields

The following fields are returned by SELECT queries:

list

Deprecated. Use [AuthToken](#/en/identity/20160918/AuthToken/) instead. Swift is the OpenStack object storage service. A SwiftPassword is an Oracle-provided password for using a Swift client with the Object Storage Service. This password is associated with the user's Console login. Swift passwords never expire. A user can have up to two Swift passwords at a time. Note: The password is always an Oracle-generated string; you can't change it to a string of your choice. For more information, see [Managing User Credentials](/Content/Identity/Tasks/managingcredentials.htm).

Name	Datatype	Description
`id`	`string`	The OCID of the Swift password.
`description`	`string`	The description you assign to the Swift password. Does not have to be unique, and it's changeable.
`expiresOn`	`string (date-time)`	Date and time when this password will expire, in the format defined by RFC3339. Null if it never expires. Example: `2016-08-25T21:10:29.600Z`
`inactiveStatus`	`integer (int64)`	The detailed status of INACTIVE lifecycleState.
`lifecycleState`	`string`	The password's current state. After creating a password, make sure its `lifecycleState` changes from CREATING to ACTIVE before using it. (CREATING, ACTIVE, INACTIVE, DELETING, DELETED)
`password`	`string`	The Swift password. The value is available only in the response for `CreateSwiftPassword`, and not for `ListSwiftPasswords` or `UpdateSwiftPassword`.
`timeCreated`	`string (date-time)`	Date and time the `SwiftPassword` object was created, in the format defined by RFC3339. Example: `2016-08-25T21:10:29.600Z`
`userId`	`string`	The OCID of the user the password belongs to.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
`list`	`select`	`userId`, `region`		Deprecated. Use [ListAuthTokens](#/en/identity/20160918/AuthToken/ListAuthTokens) instead.<br /><br />Lists the Swift passwords for the specified user. The returned object contains the password's OCID, but not<br />the password itself. The actual password is returned only upon creation.<br />
`create`	`insert`	`userId`, `region`, `description`	`opc-retry-token`	Deprecated. Use [CreateAuthToken](#/en/identity/20160918/AuthToken/CreateAuthToken) instead.<br /><br />Creates a new Swift password for the specified user. For information about what Swift passwords are for, see<br />[Managing User Credentials](/Content/Identity/Tasks/managingcredentials.htm).<br /><br />You must specify a description for the Swift password (although it can be an empty string). It does not<br />have to be unique, and you can change it anytime with<br />[UpdateSwiftPassword](#/en/identity/20160918/SwiftPassword/UpdateSwiftPassword).<br /><br />Every user has permission to create a Swift password for their own user ID. An administrator in your organization<br />does not need to write a policy to give users this ability. To compare, administrators who have permission to the<br />tenancy can use this operation to create a Swift password for any user, including themselves.<br />
`update`	`update`	`userId`, `swiftPasswordId`, `region`	`if-match`	Deprecated. Use [UpdateAuthToken](#/en/identity/20160918/AuthToken/UpdateAuthToken) instead.<br /><br />Updates the specified Swift password's description.<br />
`delete`	`delete`	`userId`, `swiftPasswordId`, `region`	`if-match`	Deprecated. Use [DeleteAuthToken](#/en/identity/20160918/AuthToken/DeleteAuthToken) instead.<br /><br />Deletes the specified Swift password for the specified user.<br />

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
`region`	`string`	OCI region identifier (e.g. us-ashburn-1, ap-sydney-1); resolves from OCI_REGION when not supplied in the query. (default: us-ashburn-1, x-stackQL-envVar: OCI_REGION)
`swiftPasswordId`	`string`	The OCID of the Swift password.
`userId`	`string`	The OCID of the user.
`if-match`	`string`	For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match` parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.
`opc-retry-token`	`string`	A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations (e.g., if a resource has been deleted and purged from the system, then a retry of the original creation request may be rejected).

`SELECT` examples

list

Deprecated. Use [ListAuthTokens](#/en/identity/20160918/AuthToken/ListAuthTokens) instead. Lists the Swift passwords for the specified user. The returned object contains the password's OCID, but not the password itself. The actual password is returned only upon creation.

SELECT
id,
description,
expiresOn,
inactiveStatus,
lifecycleState,
password,
timeCreated,
userId
FROM oci.identity.swift_passwords
WHERE userId = '{{ userId }}' -- required
AND region = '{{ region }}' -- required
;

`INSERT` examples

create
Manifest

Deprecated. Use [CreateAuthToken](#/en/identity/20160918/AuthToken/CreateAuthToken) instead. Creates a new Swift password for the specified user. For information about what Swift passwords are for, see [Managing User Credentials](/Content/Identity/Tasks/managingcredentials.htm). You must specify a description for the Swift password (although it can be an empty string). It does not have to be unique, and you can change it anytime with [UpdateSwiftPassword](#/en/identity/20160918/SwiftPassword/UpdateSwiftPassword). Every user has permission to create a Swift password for their own user ID. An administrator in your organization does not need to write a policy to give users this ability. To compare, administrators who have permission to the tenancy can use this operation to create a Swift password for any user, including themselves.

INSERT INTO oci.identity.swift_passwords (
description,
userId,
region,
opc-retry-token
)
SELECT 
'{{ description }}' /* required */,
'{{ userId }}',
'{{ region }}',
'{{ opc-retry-token }}'
RETURNING
id,
description,
expiresOn,
inactiveStatus,
lifecycleState,
password,
timeCreated,
userId
;

# Description fields are for documentation purposes
- name: swift_passwords
props:
  - name: userId
    value: "{{ userId }}"
    description: Required parameter for the swift_passwords resource.
  - name: region
    value: "{{ region }}"
    description: Required parameter for the swift_passwords resource.
  - name: description
    value: "{{ description }}"
    description: |
      The description you assign to the Swift password during creation. Does not have to be unique, and it's changeable.
      (For tenancies that support identity domains) You can have an empty description.
  - name: opc-retry-token
    value: "{{ opc-retry-token }}"
    description: A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations (e.g., if a resource has been deleted and purged from the system, then a retry of the original creation request may be rejected). 
    description: A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations (e.g., if a resource has been deleted and purged from the system, then a retry of the original creation request may be rejected). 

`UPDATE` examples

update

Deprecated. Use [UpdateAuthToken](#/en/identity/20160918/AuthToken/UpdateAuthToken) instead. Updates the specified Swift password's description.

UPDATE oci.identity.swift_passwords
SET 
description = '{{ description }}'
WHERE 
userId = '{{ userId }}' --required
AND swiftPasswordId = '{{ swiftPasswordId }}' --required
AND region = '{{ region }}' --required
AND if-match = '{{ if-match}}'
RETURNING
id,
description,
expiresOn,
inactiveStatus,
lifecycleState,
password,
timeCreated,
userId;

`DELETE` examples

delete

Deprecated. Use [DeleteAuthToken](#/en/identity/20160918/AuthToken/DeleteAuthToken) instead. Deletes the specified Swift password for the specified user.

DELETE FROM oci.identity.swift_passwords
WHERE userId = '{{ userId }}' --required
AND swiftPasswordId = '{{ swiftPasswordId }}' --required
AND region = '{{ region }}' --required
AND if-match = '{{ if-match }}'
;

Overview​

Fields​

Methods​

Parameters​

SELECT examples​

INSERT examples​

UPDATE examples​

DELETE examples​