Get the password expiry settings

GET 
/v2beta/settings/password/expiry

Return the password expiry settings for the requested context

Request

Query Parameters

ctx.orgId string
ctx.instance boolean

Responses

200

OK

application/json

Schema

Schema

details

object

sequence uint64

on read: the sequence of the last event reduced by the projection

on manipulation: the timestamp of the event(s) added by the manipulation

changeDate date-time

on read: the timestamp of the last event reduced by the projection

on manipulation: the timestamp of the event(s) added by the manipulation

resourceOwner resource_owner is the organization or instance_id an object belongs to (string)

settings

object

maxAgeDays uint64

Amount of days after which a password will expire. The user will be forced to change the password on the following authentication.

expireWarnDays uint64

Amount of days after which the user should be notified of the upcoming expiry. ZITADEL will not notify the user.

resourceOwnerType resource_owner_type returns if the settings is managed on the organization or on the instance (string)

Possible values: [RESOURCE_OWNER_TYPE_UNSPECIFIED, RESOURCE_OWNER_TYPE_INSTANCE, RESOURCE_OWNER_TYPE_ORG]

Default value: RESOURCE_OWNER_TYPE_UNSPECIFIED

Example (from schema)

{
  "details": {
    "sequence": "2",
    "changeDate": "2024-06-25T14:04:24.240Z",
    "resourceOwner": "69629023906488334"
  },
  "settings": {
    "maxAgeDays": "365",
    "expireWarnDays": "10",
    "resourceOwnerType": "RESOURCE_OWNER_TYPE_UNSPECIFIED"
  }
}

application/grpc

Schema

Schema

details

object

sequence uint64

on read: the sequence of the last event reduced by the projection

on manipulation: the timestamp of the event(s) added by the manipulation

changeDate date-time

on read: the timestamp of the last event reduced by the projection

on manipulation: the timestamp of the event(s) added by the manipulation

resourceOwner resource_owner is the organization or instance_id an object belongs to (string)

settings

object

maxAgeDays uint64

Amount of days after which a password will expire. The user will be forced to change the password on the following authentication.

expireWarnDays uint64

Amount of days after which the user should be notified of the upcoming expiry. ZITADEL will not notify the user.

resourceOwnerType resource_owner_type returns if the settings is managed on the organization or on the instance (string)

Possible values: [RESOURCE_OWNER_TYPE_UNSPECIFIED, RESOURCE_OWNER_TYPE_INSTANCE, RESOURCE_OWNER_TYPE_ORG]

Default value: RESOURCE_OWNER_TYPE_UNSPECIFIED

Example (from schema)

{
  "details": {
    "sequence": "2",
    "changeDate": "2024-06-25T14:04:24.241Z",
    "resourceOwner": "69629023906488334"
  },
  "settings": {
    "maxAgeDays": "365",
    "expireWarnDays": "10",
    "resourceOwnerType": "RESOURCE_OWNER_TYPE_UNSPECIFIED"
  }
}

application/grpc-web+proto

Schema

Schema

details

object

sequence uint64

on read: the sequence of the last event reduced by the projection

on manipulation: the timestamp of the event(s) added by the manipulation

changeDate date-time

on read: the timestamp of the last event reduced by the projection

on manipulation: the timestamp of the event(s) added by the manipulation

resourceOwner resource_owner is the organization or instance_id an object belongs to (string)

settings

object

maxAgeDays uint64

Amount of days after which a password will expire. The user will be forced to change the password on the following authentication.

expireWarnDays uint64

Amount of days after which the user should be notified of the upcoming expiry. ZITADEL will not notify the user.

resourceOwnerType resource_owner_type returns if the settings is managed on the organization or on the instance (string)

Possible values: [RESOURCE_OWNER_TYPE_UNSPECIFIED, RESOURCE_OWNER_TYPE_INSTANCE, RESOURCE_OWNER_TYPE_ORG]

Default value: RESOURCE_OWNER_TYPE_UNSPECIFIED

Example (from schema)

{
  "details": {
    "sequence": "2",
    "changeDate": "2024-06-25T14:04:24.241Z",
    "resourceOwner": "69629023906488334"
  },
  "settings": {
    "maxAgeDays": "365",
    "expireWarnDays": "10",
    "resourceOwnerType": "RESOURCE_OWNER_TYPE_UNSPECIFIED"
  }
}

403

Returned when the user does not have permission to access the resource.

application/json

Schema

Schema

code int32
message string

details

object[]

Array [

@type string

]

Example (from schema)

{
  "code": 0,
  "message": "string",
  "details": [
    {
      "@type": "string"
    }
  ]
}

application/grpc

Schema

Schema

code int32
message string

details

object[]

Array [

@type string

]

Example (from schema)

{
  "code": 0,
  "message": "string",
  "details": [
    {
      "@type": "string"
    }
  ]
}

application/grpc-web+proto

Schema

Schema

code int32
message string

details

object[]

Array [

@type string

]

Example (from schema)

{
  "code": 0,
  "message": "string",
  "details": [
    {
      "@type": "string"
    }
  ]
}

404

Returned when the resource does not exist.

application/json

Schema

Schema

code int32
message string

details

object[]

Array [

@type string

]

Example (from schema)

{
  "code": 0,
  "message": "string",
  "details": [
    {
      "@type": "string"
    }
  ]
}

application/grpc

Schema

Schema

code int32
message string

details

object[]

Array [

@type string

]

Example (from schema)

{
  "code": 0,
  "message": "string",
  "details": [
    {
      "@type": "string"
    }
  ]
}

application/grpc-web+proto

Schema

Schema

code int32
message string

details

object[]

Array [

@type string

]

Example (from schema)

{
  "code": 0,
  "message": "string",
  "details": [
    {
      "@type": "string"
    }
  ]
}

default

An unexpected error response.

application/json

Schema

Schema

code int32
message string

details

object[]

Array [

@type string

]

Example (from schema)

{
  "code": 0,
  "message": "string",
  "details": [
    {
      "@type": "string"
    }
  ]
}

application/grpc

Schema

Schema

code int32
message string

details

object[]

Array [

@type string

]

Example (from schema)

{
  "code": 0,
  "message": "string",
  "details": [
    {
      "@type": "string"
    }
  ]
}

application/grpc-web+proto

Schema

Schema

code int32
message string

details

object[]

Array [

@type string

]

Example (from schema)

{
  "code": 0,
  "message": "string",
  "details": [
    {
      "@type": "string"
    }
  ]
}

Loading...