---
title: "Get Password Policy by ID"
method: GET
path: "/api/v2/passwordpolicies/{objectId}"
tags: ["Password Policy"]
---

# Get Password Policy by ID

`GET /api/v2/passwordpolicies/{objectId}`

## Request

- Base URL: `https://console.jumpcloud.com`
- URL: `https://console.jumpcloud.com/api/v2/passwordpolicies/{objectId}`
- Auth: API key in header `x-api-key`
- TypeScript: <https://skmtc.dev/jumpcloud/apis/jumpcloud-console-api/docs/api/v2/passwordpolicies/:objectId/get.ts> (a function with typed inputs; its response is checked against the schema)

Get a password policy by its object ID.

## Path parameters

- `objectId` string, byte, required

## Query parameters

- `organizationObjectId` string, byte

## Response `200`

A successful response.

- JumpcloudPasswordResponse
  - `cached` boolean
  - `groups` JumpcloudPasswordGroupResponse[]
    - `groupId` string, byte
    - `name` string
  - `objectId` string, byte
  - `organizationObjectId` string, byte
  - `policy` JumpcloudPasswordPasswordPolicy
    - `allowUnenrolledMFAPasswordReset` boolean
    - `allowUsernameSubstring` boolean
    - `daysAfterExpirationToSelfRecover` integer
    - `daysBeforeExpirationToForceReset` integer
    - `default` boolean
    - `description` string
    - `disallowCommonlyUsedPasswords` boolean
    - `disallowCustomBannedPasswords` boolean
    - `disallowNameSubstring` boolean
    - `disallowSequentialOrRepetitiveChars` boolean
    - `displayComplexityOnResetScreen` boolean
    - `effectiveDate` string, date-time
    - `enableDaysAfterExpirationToSelfRecover` boolean
    - `enableDaysBeforeExpirationToForceReset` boolean
    - `enableLockoutTimeInSeconds` boolean
    - `enableMaxHistory` boolean
    - `enableMaxLoginAttempts` boolean
    - `enableMinChangePeriodInDays` boolean
    - `enableMinLength` boolean
    - `enableNameConsecutiveChars` boolean
    - `enablePasswordExpirationInDays` boolean
    - `enableRecoveryEmail` boolean
    - `enableResetLockoutCounter` boolean
    - `lockoutTimeInSeconds` integer
    - `maxHistory` integer
    - `maxLoginAttempts` integer
    - `minChangePeriodInDays` integer
    - `minLength` integer
    - `name` string
    - `nameConsecutiveChars` integer
    - `needsLowercase` boolean
    - `needsNumeric` boolean
    - `needsSymbolic` boolean
    - `needsUppercase` boolean
    - `passwordExpirationInDays` integer
    - `precedence` integer
    - `resetLockoutCounterMinutes` integer

---

[API](https://skmtc.dev/jumpcloud/apis/jumpcloud-console-api.md) - [All operations](https://skmtc.dev/jumpcloud/apis/jumpcloud-console-api/llms.txt) - [OpenAPI document](https://skmtc.dev/jumpcloud/apis/jumpcloud-console-api/revisions/f396d9271b46?raw)