---
updatedAt: 2026-05-21T14:47:46.000Z
---
# Retrieves the authenticated user's effective password policy.
Entitlement required: readSelfProfile (Read your user profile) or manageSelfProfile (Manage your user profile).
Note: You only need one entitlement, but you can have more than one.
This API requires an authenticated user's access token that is generated from an application client during sign-on. This API does not support the use of an API client-generated access token.
# OpenAPI definition
```json
{
"openapi": "3.0.1",
"info": {
"version": "1.0.0",
"description": "Users & Groups",
"title": "Users & Groups"
},
"servers": [
{
"url": "https://{tenanturl}",
"variables": {
"tenanturl": {
"default": "{tenant_url}",
"description": "URL of your IBM Security Verify tenant"
}
}
}
],
"tags": [
{
"name": "Users Management Version 2.0",
"description": ""
}
],
"paths": {
"/v2.0/Me/effectivePasswordPolicy": {
"get": {
"tags": [
"Users Management Version 2.0"
],
"summary": "Retrieves the authenticated user's effective password policy.",
"description": "Entitlement required: readSelfProfile (Read your user profile) or manageSelfProfile (Manage your user profile).
Note: You only need one entitlement, but you can have more than one.
This API requires an authenticated user's access token that is generated from an application client during sign-on. This API does not support the use of an API client-generated access token.",
"operationId": "getEffectivePasswordPolicy",
"responses": {
"200": {
"description": "The operation was successful.",
"content": {
"application/scim+json": {
"schema": {
"$ref": "#/components/schemas/PasswordPolicyResponseV31"
}
}
}
},
"400": {
"description": "The request was incorrect.",
"content": {
"application/scim+json": {
"schema": {
"$ref": "#/components/schemas/ExternalErrorMessage1"
}
}
}
},
"404": {
"description": "Not found.",
"content": {
"application/scim+json": {
"schema": {
"$ref": "#/components/schemas/ExternalErrorMessage1"
}
}
}
},
"500": {
"description": "An internal server error occurred.",
"content": {
"application/scim+json": {
"schema": {
"$ref": "#/components/schemas/ExternalErrorMessage1"
}
}
}
},
"529": {
"description": "The request timed out.",
"content": {
"application/scim+json": {
"schema": {
"$ref": "#/components/schemas/ExternalErrorMessage1"
}
}
}
}
},
"x-category": "Users & Groups",
"x-publicAPI": "true"
}
}
},
"components": {
"schemas": {
"ExternalErrorMessage1": {
"required": [
"schemas",
"status"
],
"type": "object",
"properties": {
"schemas": {
"type": "array",
"description": "An array of strings that contain the URIs that indicate the namespaces of the SCIM schemas that define the attributes in the current JSON structure. The schema \"urn:ietf:params:scim:api:messages:2.0:Error\" is the URI as required by the SCIM specification.",
"items": {
"type": "string"
}
},
"status": {
"type": "string",
"description": "The HTTP status code expressed as a JSON string."
},
"detail": {
"type": "string",
"description": "A detailed human-readable message."
}
}
},
"PasswordPolicyResponseV31": {
"required": [
"id",
"passwordSecurity",
"passwordStrength"
],
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "The unique id of this password policy."
},
"passwordStrength": {
"$ref": "#/components/schemas/PasswordStrengthV31"
},
"passwordSecurity": {
"$ref": "#/components/schemas/PasswordSecurityV31"
},
"name": {
"type": "string"
},
"description": {
"type": "string"
},
"predefined": {
"type": "boolean"
}
}
},
"PasswordSecurityV31": {
"type": "object",
"properties": {
"pwdMinAge": {
"type": "integer",
"description": "Specifies the number of seconds before a password can be modified again. Can't be larger than pwdMaxAge.",
"format": "int32"
},
"pwdExpireWarning": {
"type": "integer",
"description": "Specifies the maximum number of seconds before a password expires that an expiration warning message is returned to an authenticating user.",
"format": "int32"
},
"pwdInHistory": {
"type": "integer",
"description": "Specifies the number of passwords that are stored in the pwdHistory attribute.",
"format": "int32"
},
"pwdLockout": {
"type": "boolean",
"description": "Indicates whether a password can be used to authenticate after a specified number of consecutive failed bind attempts. If the attribute is not provided, the behavior defaults to false."
},
"pwdLockoutDuration": {
"type": "integer",
"description": "Specifies the number of seconds that the password cannot be used to authenticate due to the specified 'pwdMaxFailure' failed bind attempts.",
"format": "int32"
},
"pwdMaxAge": {
"type": "integer",
"description": "Specifies the number of seconds after which a password will expire (0 means password does not expire)Must be greater than or equal to pwdMinAge.",
"format": "int32"
},
"pwdMaxFailure": {
"type": "integer",
"format": "int32"
}
}
},
"PasswordStrengthV31": {
"type": "object",
"properties": {
"pwdMinLength": {
"type": "integer",
"description": "Specifies the minimum length for the password string. The server checks the minimum length depending upon the value of the pwdCheckSyntax attribute.Must be greater than or equal to the sum of 'passwordMinAlphaChars' and 'passwordMinOtherChars'",
"format": "int32"
},
"passwordMaxConsecutiveRepeatedChars": {
"type": "integer",
"description": "Specifies the maximum successive repetitions of a given character in the password.",
"format": "int32"
},
"passwordMaxRepeatedChars": {
"type": "integer",
"description": "Specifies the maximum number of times a given character can be used in a password. If the server is unable to check the actual password characters, then the server will continue processing depending on the value of the pwdCheckSyntax attribute.",
"format": "int32"
},
"passwordMinAlphaChars": {
"type": "integer",
"description": "Specifies the minimum number of alphabetic characters that the password string must have. If the server is unable to check the number of alphabetic characters, then the server continues processing depending on the value of the pwdCheckSyntax attribute.",
"format": "int32"
},
"passwordMinDiffChars": {
"type": "integer",
"description": "Specifies the minimum number of characters in the new password that must be different from the characters in the old password, and any passwords stored in the pwdHistory. If the password has been one-way encrypted the server is unable to check actual password characters, then the server will continue processing depending on the value of the pwdCheckSyntax attribute.",
"format": "int32"
},
"passwordMinOtherChars": {
"type": "integer",
"description": "Specifies the minimum number of numeric and special characters that the password string must have. If the server is unable to check the number of other characters, then the server continues processing depending on the value of the pwdCheckSyntax attribute.",
"format": "int32"
},
"passwordMinLowerCaseChars": {
"type": "integer",
"description": "Specifies the minimum number of lower case alphabetic characters that the password string must have.",
"format": "int32"
},
"passwordMinUpperCaseChars": {
"type": "integer",
"description": "Specifies the minimum number of upper case alphabetic characters that the password string must have.",
"format": "int32"
},
"passwordMinNumberChars": {
"type": "integer",
"description": "Specifies the minimum number of numeric characters that the password string must have.",
"format": "int32"
},
"passwordMinSpecialChars": {
"type": "integer",
"description": "Specifies the minimum number of special characters that the password string must have.",
"format": "int32"
}
}
}
}
},
"x-original-swagger-version": "2.0",
"x-explorer-enabled": false
}
```