API ReferenceManagementPassword Management
GET
/v2/mgmt/password/settings

Authorization

Descope Project ID and Management Key
AuthorizationBearer <token>

Project ID:Management Key as bearer token.

In: header

Get the project's password settings, using a valid management key.

curl -X GET "https://api.descope.com/v2/mgmt/password/settings"
{  "enabled": true,  "minLength": 0,  "lowercase": true,  "uppercase": true,  "number": true,  "nonAlphanumeric": true,  "anyLetter": true,  "disallowedCharacters": "string",  "disallowEmailMatch": true,  "expiration": true,  "expirationWeeks": 0,  "reuse": true,  "reuseAmount": 0,  "lock": true,  "lockAttempts": 0,  "tempLock": true,  "tempLockAttempts": 0,  "tempLockDuration": 0,  "enablePasswordStrength": true,  "passwordStrengthScore": 0,  "maskError": true,  "emailConnectorId": "string",  "emailTemplateId": "string",  "externalEmailTemplateId": "string",  "rolePolicies": null}
/** * Password (Terraform: descope_password_settings). Carries the same representation used in *  exported snapshots, and the Get response and Set request are the same message. *  Patch semantics: omitted fields are left untouched; present fields are written. */export interface Response {enabled?: booleanminLength?: numberlowercase?: booleanuppercase?: booleannumber?: booleannonAlphanumeric?: booleananyLetter?: booleandisallowedCharacters?: stringdisallowEmailMatch?: booleanexpiration?: booleanexpirationWeeks?: numberreuse?: booleanreuseAmount?: numberlock?: booleanlockAttempts?: numbertempLock?: booleantempLockAttempts?: numbertempLockDuration?: numberenablePasswordStrength?: booleanpasswordStrengthScore?: numbermaskError?: booleanemailConnectorId?: string/** * Active template selection by id. Absent = keep the current selection; "" = reset to the *  built-in System template; a template id = select that stored template. Note that the same *  stored templates serve both the magic link and enchanted link reset flavors. */emailTemplateId?: stringexternalEmailTemplateId?: string/** * Stricter complexity rules for users who hold specific roles, as a JSON array of policy objects. Each policy has a *  "roleNames" array with the names of project roles, and any of the complexity fields of these settings: "minLength", *  "lowercase", "uppercase", "number", "nonAlphanumeric", "anyLetter", "disallowedCharacters", "disallowEmailMatch", *  "enablePasswordStrength" and "passwordStrengthScore". For a user who holds any of the listed roles, at the project *  level or in one of their tenants, each rule is merged with these settings and the strictest value wins, so a *  policy can only make the password requirements stricter. The policies apply when a signed-in user sets or changes *  their own password. Value makes empty and absent distinct: null/absent = keep, [] = clear, values = set. *  Validated in the service */rolePolicies?: {[k: string]: unknown}}
Was this helpful?