Get Password Age Settings
GET/policies/password/age
Returns the password age settings configured on the instance. It affects all organizations, that do not have a custom setting configured. The settings specify the expiry of password, after which a user is forced to change it on the next login.
Responses​
- 200
- 403
- 404
- default
default password age policy
- application/json
- application/grpc
- application/grpc-web+proto
- Schema
- Example (from schema)
Schema
policy
object
details
object
on read: the sequence of the last event reduced by the projection
on manipulation: the timestamp of the event(s) added by the manipulation
on read: the timestamp of the first event of the object
on create: the timestamp of the event(s) added by the manipulation
on read: the timestamp of the last event reduced by the projection
on manipulation: the
Amount of days after which a password will expire. The user will be forced to change the password on the following authentication.
Amount of days after which the user should be notified of the upcoming expiry. ZITADEL will not notify the user.
If true, the returned values represent the instance settings, e.g. by an organization without custom settings.
{
"policy": {
"details": {
"sequence": "2",
"creationDate": "2024-11-04T10:46:45.285Z",
"changeDate": "2024-11-04T10:46:45.285Z",
"resourceOwner": "69629023906488334"
},
"maxAgeDays": "365",
"expireWarnDays": "10",
"isDefault": true
}
}
- Schema
- Example (from schema)
Schema
policy
object
details
object
on read: the sequence of the last event reduced by the projection
on manipulation: the timestamp of the event(s) added by the manipulation
on read: the timestamp of the first event of the object
on create: the timestamp of the event(s) added by the manipulation
on read: the timestamp of the last event reduced by the projection
on manipulation: the
Amount of days after which a password will expire. The user will be forced to change the password on the following authentication.
Amount of days after which the user should be notified of the upcoming expiry. ZITADEL will not notify the user.
If true, the returned values represent the instance settings, e.g. by an organization without custom settings.
{
"policy": {
"details": {
"sequence": "2",
"creationDate": "2024-11-04T10:46:45.285Z",
"changeDate": "2024-11-04T10:46:45.285Z",
"resourceOwner": "69629023906488334"
},
"maxAgeDays": "365",
"expireWarnDays": "10",
"isDefault": true
}
}
- Schema
- Example (from schema)
Schema
policy
object
details
object
on read: the sequence of the last event reduced by the projection
on manipulation: the timestamp of the event(s) added by the manipulation
on read: the timestamp of the first event of the object
on create: the timestamp of the event(s) added by the manipulation
on read: the timestamp of the last event reduced by the projection
on manipulation: the
Amount of days after which a password will expire. The user will be forced to change the password on the following authentication.
Amount of days after which the user should be notified of the upcoming expiry. ZITADEL will not notify the user.
If true, the returned values represent the instance settings, e.g. by an organization without custom settings.
{
"policy": {
"details": {
"sequence": "2",
"creationDate": "2024-11-04T10:46:45.285Z",
"changeDate": "2024-11-04T10:46:45.286Z",
"resourceOwner": "69629023906488334"
},
"maxAgeDays": "365",
"expireWarnDays": "10",
"isDefault": true
}
}
Returned when the user does not have permission to access the resource.
- application/json
- application/grpc
- application/grpc-web+proto
- Schema
- Example (from schema)
Schema
Array [
]
details
object[]
{
"code": 0,
"message": "string",
"details": [
{
"@type": "string"
}
]
}
- Schema
- Example (from schema)
Schema
Array [
]
details
object[]
{
"code": 0,
"message": "string",
"details": [
{
"@type": "string"
}
]
}
- Schema
- Example (from schema)
Schema
Array [
]
details
object[]
{
"code": 0,
"message": "string",
"details": [
{
"@type": "string"
}
]
}
Returned when the resource does not exist.
- application/json
- application/grpc
- application/grpc-web+proto
- Schema
- Example (from schema)
Schema
Array [
]
details
object[]
{
"code": 0,
"message": "string",
"details": [
{
"@type": "string"
}
]
}
- Schema
- Example (from schema)
Schema
Array [
]
details
object[]
{
"code": 0,
"message": "string",
"details": [
{
"@type": "string"
}
]
}
- Schema
- Example (from schema)
Schema
Array [
]
details
object[]
{
"code": 0,
"message": "string",
"details": [
{
"@type": "string"
}
]
}
An unexpected error response.
- application/json
- application/grpc
- application/grpc-web+proto
- Schema
- Example (from schema)
Schema
Array [
]
details
object[]
{
"code": 0,
"message": "string",
"details": [
{
"@type": "string"
}
]
}
- Schema
- Example (from schema)
Schema
Array [
]
details
object[]
{
"code": 0,
"message": "string",
"details": [
{
"@type": "string"
}
]
}
- Schema
- Example (from schema)
Schema
Array [
]
details
object[]
{
"code": 0,
"message": "string",
"details": [
{
"@type": "string"
}
]
}