Package com.okta.sdk.resource.model

Class PasswordCredentialHash

java.lang.Object

com.okta.sdk.resource.model.PasswordCredentialHash

All Implemented Interfaces:

Serializable

@Generated(value="org.openapitools.codegen.languages.JavaClientCodegen",
           date="2024-08-09T14:20:25.727262-05:00[America/Chicago]",
           comments="Generator version: 7.7.0")
public class PasswordCredentialHash
extends Object
implements Serializable

Specifies a hashed password to import into Okta. This allows an existing password to be imported into Okta directly from some other store. Okta supports the BCRYPT, SHA-512, SHA-256, SHA-1, MD5, and PBKDF2 hash functions for password import. A hashed password may be specified in a Password object when creating or updating a user, but not for other operations. See [Create User with Imported Hashed Password](https://developer.okta.com/docs/reference/api/users/#create-user-with-imported-hashed-password) for information on using this object when creating a user. When updating a user with a hashed password, the user must be in the `STAGED` status.

See Also:

• Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
static final String	JSON_PROPERTY_ALGORITHM
static final String	JSON_PROPERTY_DIGEST_ALGORITHM
static final String	JSON_PROPERTY_ITERATION_COUNT
static final String	JSON_PROPERTY_KEY_SIZE
static final String	JSON_PROPERTY_SALT
static final String	JSON_PROPERTY_SALT_ORDER
static final String	JSON_PROPERTY_VALUE
static final String	JSON_PROPERTY_WORK_FACTOR

Constructor Summary

Constructors

Constructor	Description
PasswordCredentialHash()

Method Summary

Modifier and Type	Method	Description
PasswordCredentialHash	algorithm(PasswordCredentialHashAlgorithm algorithm)
PasswordCredentialHash	digestAlgorithm(DigestAlgorithm digestAlgorithm)
boolean	equals(Object o)
PasswordCredentialHashAlgorithm	getAlgorithm()	Get algorithm
DigestAlgorithm	getDigestAlgorithm()	Get digestAlgorithm
Integer	getIterationCount()	The number of iterations used when hashing passwords using PBKDF2.
Integer	getKeySize()	Size of the derived key in bytes.
String	getSalt()	Only required for salted hashes.
String	getSaltOrder()	Specifies whether salt was pre- or postfixed to the password before hashing.
String	getValue()	For SHA-512, SHA-256, SHA-1, MD5, and PBKDF2, this is the actual base64-encoded hash of the password (and salt, if used).
Integer	getWorkFactor()	Governs the strength of the hash and the time required to compute it.
int	hashCode()
PasswordCredentialHash	iterationCount(Integer iterationCount)
PasswordCredentialHash	keySize(Integer keySize)
PasswordCredentialHash	salt(String salt)
PasswordCredentialHash	saltOrder(String saltOrder)
void	setAlgorithm(PasswordCredentialHashAlgorithm algorithm)
void	setDigestAlgorithm(DigestAlgorithm digestAlgorithm)
void	setIterationCount(Integer iterationCount)
void	setKeySize(Integer keySize)
void	setSalt(String salt)
void	setSaltOrder(String saltOrder)
void	setValue(String value)
void	setWorkFactor(Integer workFactor)
String	toString()
PasswordCredentialHash	value(String value)
PasswordCredentialHash	workFactor(Integer workFactor)

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Details

JSON_PROPERTY_ALGORITHM

public static final String JSON_PROPERTY_ALGORITHM

See Also:

• Constant Field Values

JSON_PROPERTY_DIGEST_ALGORITHM

public static final String JSON_PROPERTY_DIGEST_ALGORITHM

See Also:

• Constant Field Values

JSON_PROPERTY_ITERATION_COUNT

public static final String JSON_PROPERTY_ITERATION_COUNT

See Also:

• Constant Field Values

JSON_PROPERTY_KEY_SIZE

public static final String JSON_PROPERTY_KEY_SIZE

See Also:

• Constant Field Values

JSON_PROPERTY_SALT

public static final String JSON_PROPERTY_SALT

See Also:

• Constant Field Values

JSON_PROPERTY_SALT_ORDER

public static final String JSON_PROPERTY_SALT_ORDER

See Also:

• Constant Field Values

JSON_PROPERTY_VALUE

public static final String JSON_PROPERTY_VALUE

See Also:

• Constant Field Values

JSON_PROPERTY_WORK_FACTOR

public static final String JSON_PROPERTY_WORK_FACTOR

See Also:

• Constant Field Values

Constructor Details

PasswordCredentialHash

public PasswordCredentialHash()

Method Details

algorithm

public PasswordCredentialHash algorithm(PasswordCredentialHashAlgorithm algorithm)

getAlgorithm

@Nullable
public PasswordCredentialHashAlgorithm getAlgorithm()

Get algorithm

Returns:

algorithm

setAlgorithm

public void setAlgorithm(PasswordCredentialHashAlgorithm algorithm)

digestAlgorithm

public PasswordCredentialHash digestAlgorithm(DigestAlgorithm digestAlgorithm)

getDigestAlgorithm

@Nullable
public DigestAlgorithm getDigestAlgorithm()

Get digestAlgorithm

Returns:

digestAlgorithm

setDigestAlgorithm

public void setDigestAlgorithm(DigestAlgorithm digestAlgorithm)

iterationCount

public PasswordCredentialHash iterationCount(Integer iterationCount)

getIterationCount

@Nullable
public Integer getIterationCount()

The number of iterations used when hashing passwords using PBKDF2. Must be >= 4096. Only required for PBKDF2 algorithm.

Returns:

iterationCount

setIterationCount

public void setIterationCount(Integer iterationCount)

keySize

public PasswordCredentialHash keySize(Integer keySize)

getKeySize

@Nullable
public Integer getKeySize()

Size of the derived key in bytes. Only required for PBKDF2 algorithm.

Returns:

keySize

setKeySize

public void setKeySize(Integer keySize)

salt

public PasswordCredentialHash salt(String salt)

getSalt

@Nullable
public String getSalt()

Only required for salted hashes. For BCRYPT, this specifies Radix-64 as the encoded salt used to generate the hash, which must be 22 characters long. For other salted hashes, this specifies the Base64-encoded salt used to generate the hash.

Returns:

salt

setSalt

public void setSalt(String salt)

saltOrder

public PasswordCredentialHash saltOrder(String saltOrder)

getSaltOrder

@Nullable
public String getSaltOrder()

Specifies whether salt was pre- or postfixed to the password before hashing. Only required for salted algorithms.

Returns:

saltOrder

setSaltOrder

public void setSaltOrder(String saltOrder)

value

public PasswordCredentialHash value(String value)

getValue

@Nullable
public String getValue()

For SHA-512, SHA-256, SHA-1, MD5, and PBKDF2, this is the actual base64-encoded hash of the password (and salt, if used). This is the Base64-encoded `value` of the SHA-512/SHA-256/SHA-1/MD5/PBKDF2 digest that was computed by either pre-fixing or post-fixing the `salt` to the `password`, depending on the `saltOrder`. If a `salt` was not used in the `source` system, then this should just be the Base64-encoded `value` of the password's SHA-512/SHA-256/SHA-1/MD5/PBKDF2 digest. For BCRYPT, this is the actual Radix-64 encoded hashed password.

Returns:

value

setValue

public void setValue(String value)

workFactor

public PasswordCredentialHash workFactor(Integer workFactor)

getWorkFactor

@Nullable
public Integer getWorkFactor()

Governs the strength of the hash and the time required to compute it. Only required for BCRYPT algorithm. minimum: 1 maximum: 20

Returns:

workFactor

setWorkFactor

public void setWorkFactor(Integer workFactor)

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object