Get the password complexity settings

GET 
https://$CUSTOM-DOMAIN/v2/settings/password/complexity

Return the password complexity 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)

creationDate date-time

settings

object

minLength uint64

Defines the minimum length of a password.

requiresUppercase boolean

defines if the password MUST contain an upper case letter

requiresLowercase boolean

defines if the password MUST contain a lowercase letter

requiresNumber boolean

defines if the password MUST contain a number

requiresSymbol boolean

defines if the password MUST contain a symbol. E.g. "$"

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

resource_owner_type returns if the settings is managed on the organization or on the instance

Example (from schema)

{
  "details": {
    "sequence": "2",
    "changeDate": "2025-03-28T12:37:40.439Z",
    "resourceOwner": "69629023906488334",
    "creationDate": "2025-03-28T12:37:40.439Z"
  },
  "settings": {
    "minLength": "8",
    "requiresUppercase": true,
    "requiresLowercase": true,
    "requiresNumber": true,
    "requiresSymbol": true,
    "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)

creationDate date-time

settings

object

minLength uint64

Defines the minimum length of a password.

requiresUppercase boolean

defines if the password MUST contain an upper case letter

requiresLowercase boolean

defines if the password MUST contain a lowercase letter

requiresNumber boolean

defines if the password MUST contain a number

requiresSymbol boolean

defines if the password MUST contain a symbol. E.g. "$"

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

resource_owner_type returns if the settings is managed on the organization or on the instance

Example (from schema)

{
  "details": {
    "sequence": "2",
    "changeDate": "2025-03-28T12:37:40.440Z",
    "resourceOwner": "69629023906488334",
    "creationDate": "2025-03-28T12:37:40.440Z"
  },
  "settings": {
    "minLength": "8",
    "requiresUppercase": true,
    "requiresLowercase": true,
    "requiresNumber": true,
    "requiresSymbol": true,
    "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)

creationDate date-time

settings

object

minLength uint64

Defines the minimum length of a password.

requiresUppercase boolean

defines if the password MUST contain an upper case letter

requiresLowercase boolean

defines if the password MUST contain a lowercase letter

requiresNumber boolean

defines if the password MUST contain a number

requiresSymbol boolean

defines if the password MUST contain a symbol. E.g. "$"

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

resource_owner_type returns if the settings is managed on the organization or on the instance

Example (from schema)

{
  "details": {
    "sequence": "2",
    "changeDate": "2025-03-28T12:37:40.440Z",
    "resourceOwner": "69629023906488334",
    "creationDate": "2025-03-28T12:37:40.440Z"
  },
  "settings": {
    "minLength": "8",
    "requiresUppercase": true,
    "requiresLowercase": true,
    "requiresNumber": true,
    "requiresSymbol": true,
    "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"
    }
  ]
}

• curl
• python
• go
• nodejs
• ruby
• csharp
• php
• java
• powershell

• CURL

curl -L 'https://$CUSTOM-DOMAIN/v2/settings/password/complexity' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <TOKEN>'

Request Collapse all

Base URL

https://$CUSTOM-DOMAIN

Auth

Bearer Token

Parameters

ctx.orgId — query

ctx.instance — query

---truefalse

ResponseClear

Click the Send API Request button above and see the response here!