PasswordPolicy

A password policy describes a set of rules regarding passwords. Authorization is controlled via JWT.

This tag groups all operations for passwordpolicy.

Retrieve all PasswordPolicy

get

This endpoint enables retrieving all PasswordPolicy using pagination and optional filters.

Authorizations

Query parameters

effectivePolicybooleanOptional

When set to true, then the policy that is in effect for the actor's contract (as defined by the JWT) is returned. ATM this has the only effect that if no policy is defined for the user/contract, then the IONOS default policy is returned.

Example: false

Responses

200

Returned all requested PasswordPolicy successfully.

application/json

Responseall of

400

### Bad Request The request send to the API was malformed.

application/json

401

### Unauthorized The request is missing authorization information or the authorization information provided are expired.

application/json

403

### Not Allowed The user issuing the request does not have the needed permissions.

application/json

429

### Too Many Requests The user has sent too many requests in a given amount of time.

application/json

500

### Internal Server Error An internal error occurred. We apologize for the inconvenience!

application/json

503

### Service Unavailable The server is currently unable to handle the request due to a temporary overloading or maintenance of the server.

application/json

default

### Unexpected Internal Server Error An unexpected internal error occurred. We apologize for the inconvenience!

application/json

get

GET /passwordpolicies HTTP/1.1
Host: iam.ionos.com
Authorization: Bearer JWT
Accept: */*

{
  "id": "95f76a5e-86cd-52e0-b080-f22f131718e5",
  "type": "collection",
  "href": "/passwordpolicies",
  "items": [
    {
      "id": "70323699-7c28-58e7-9e0c-ff644f6947a5",
      "type": "passwordpolicy",
      "href": "/passwordpolicies/70323699-7c28-58e7-9e0c-ff644f6947a5",
      "metadata": {
        "createdDate": "2020-12-10T13:37:50+01:00",
        "createdBy": "ionos:identity:::users/87f9a82e-b28d-49ed-9d04-fba2c0459cd3",
        "createdByUserId": "87f9a82e-b28d-49ed-9d04-fba2c0459cd3",
        "lastModifiedDate": "2020-12-11T13:37:50+01:00",
        "lastModifiedBy": "ionos:identity:::users/87f9a82e-b28d-49ed-9d04-fba2c0459cd3",
        "lastModifiedByUserId": "87f9a82e-b28d-49ed-9d04-fba2c0459cd3",
        "resourceURN": "ionos:<product>:<location>:<contract>:<resource-path>"
      },
      "properties": {
        "description": "Password policy for John Doe.",
        "minLength": 1,
        "minNumberChars": 0,
        "minUpperChars": 0,
        "minLowerChars": 0,
        "minSpecialChars": 0
      }
    }
  ]
}

Create PasswordPolicy

post

Creates a new PasswordPolicy.

The full PasswordPolicy needs to be provided to create the object. Optional data will be filled with defaults or left empty.

Authorizations

Body

metadataanyOptional

Metadata

Responses

201

PasswordPolicy successfully created.

application/json

400

### Bad Request The request send to the API was malformed.

application/json

401

### Unauthorized The request is missing authorization information or the authorization information provided are expired.

application/json

403

### Not Allowed The user issuing the request does not have the needed permissions.

application/json

415

### Unsupported Media Type The request has an unsupported media type.

application/json

422

### Unprocessable Entity The request was well-formed but was unable to be followed due to semantic errors.

application/json

429

### Too Many Requests The user has sent too many requests in a given amount of time.

application/json

500

### Internal Server Error An internal error occurred. We apologize for the inconvenience!

application/json

503

### Service Unavailable The server is currently unable to handle the request due to a temporary overloading or maintenance of the server.

application/json

default

### Unexpected Internal Server Error An unexpected internal error occurred. We apologize for the inconvenience!

application/json

post

POST /passwordpolicies HTTP/1.1
Host: iam.ionos.com
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 165

{
  "metadata": {},
  "properties": {
    "description": "Password policy for John Doe.",
    "minLength": 1,
    "minNumberChars": 0,
    "minUpperChars": 0,
    "minLowerChars": 0,
    "minSpecialChars": 0
  }
}

{
  "id": "70323699-7c28-58e7-9e0c-ff644f6947a5",
  "type": "passwordpolicy",
  "href": "/passwordpolicies/70323699-7c28-58e7-9e0c-ff644f6947a5",
  "metadata": {
    "createdDate": "2020-12-10T13:37:50+01:00",
    "createdBy": "ionos:identity:::users/87f9a82e-b28d-49ed-9d04-fba2c0459cd3",
    "createdByUserId": "87f9a82e-b28d-49ed-9d04-fba2c0459cd3",
    "lastModifiedDate": "2020-12-11T13:37:50+01:00",
    "lastModifiedBy": "ionos:identity:::users/87f9a82e-b28d-49ed-9d04-fba2c0459cd3",
    "lastModifiedByUserId": "87f9a82e-b28d-49ed-9d04-fba2c0459cd3",
    "resourceURN": "ionos:<product>:<location>:<contract>:<resource-path>"
  },
  "properties": {
    "description": "Password policy for John Doe.",
    "minLength": 1,
    "minNumberChars": 0,
    "minUpperChars": 0,
    "minLowerChars": 0,
    "minSpecialChars": 0
  }
}

Retrieve PasswordPolicy

get

Returns the PasswordPolicy by ID.

Authorizations

Path parameters

passwordPolicyIdstring · uuidRequired

The ID (UUID) of the PasswordPolicy.

Example: 70323699-7c28-58e7-9e0c-ff644f6947a5

Responses

200

Getting PasswordPolicy was successful.

application/json

400

### Bad Request The request send to the API was malformed.

application/json

401

### Unauthorized The request is missing authorization information or the authorization information provided are expired.

application/json

403

### Not Allowed The user issuing the request does not have the needed permissions.

application/json

404

### Not Found The resource that was requested could not be found.

application/json

429

### Too Many Requests The user has sent too many requests in a given amount of time.

application/json

500

### Internal Server Error An internal error occurred. We apologize for the inconvenience!

application/json

503

### Service Unavailable The server is currently unable to handle the request due to a temporary overloading or maintenance of the server.

application/json

default

### Unexpected Internal Server Error An unexpected internal error occurred. We apologize for the inconvenience!

application/json

get

GET /passwordpolicies/{passwordPolicyId} HTTP/1.1
Host: iam.ionos.com
Authorization: Bearer JWT
Accept: */*

{
  "id": "70323699-7c28-58e7-9e0c-ff644f6947a5",
  "type": "passwordpolicy",
  "href": "/passwordpolicies/70323699-7c28-58e7-9e0c-ff644f6947a5",
  "metadata": {
    "createdDate": "2020-12-10T13:37:50+01:00",
    "createdBy": "ionos:identity:::users/87f9a82e-b28d-49ed-9d04-fba2c0459cd3",
    "createdByUserId": "87f9a82e-b28d-49ed-9d04-fba2c0459cd3",
    "lastModifiedDate": "2020-12-11T13:37:50+01:00",
    "lastModifiedBy": "ionos:identity:::users/87f9a82e-b28d-49ed-9d04-fba2c0459cd3",
    "lastModifiedByUserId": "87f9a82e-b28d-49ed-9d04-fba2c0459cd3",
    "resourceURN": "ionos:<product>:<location>:<contract>:<resource-path>"
  },
  "properties": {
    "description": "Password policy for John Doe.",
    "minLength": 1,
    "minNumberChars": 0,
    "minUpperChars": 0,
    "minLowerChars": 0,
    "minSpecialChars": 0
  }
}

Ensure PasswordPolicy

put

Ensures that the PasswordPolicy with the provided ID is created or modified. The full PasswordPolicy needs to be provided to ensure (either update or create) the PasswordPolicy. Non present data will only be filled with defaults or left empty, but not take previous values into consideration.

Authorizations

Path parameters

passwordPolicyIdstring · uuidRequired

The ID (UUID) of the PasswordPolicy.

Example: 70323699-7c28-58e7-9e0c-ff644f6947a5

Body

idstring · uuidRequired

The ID (UUID) of the PasswordPolicy.

Example: 70323699-7c28-58e7-9e0c-ff644f6947a5

metadataanyOptional

Metadata

Responses

200

PasswordPolicy successfully updated.

application/json

201

PasswordPolicy successfully ensured.

application/json

400

### Bad Request The request send to the API was malformed.

application/json

401

### Unauthorized The request is missing authorization information or the authorization information provided are expired.

application/json

403

### Not Allowed The user issuing the request does not have the needed permissions.

application/json

404

### Not Found The resource that was requested could not be found.

application/json

409

### Conflict The UUID is already taken by another party, follow the guides to generate UUIDs uniquely.

application/json

415

### Unsupported Media Type The request has an unsupported media type.

application/json

422

### Unprocessable Entity The request was well-formed but was unable to be followed due to semantic errors.

application/json

429

### Too Many Requests The user has sent too many requests in a given amount of time.

application/json

500

### Internal Server Error An internal error occurred. We apologize for the inconvenience!

application/json

503

### Service Unavailable The server is currently unable to handle the request due to a temporary overloading or maintenance of the server.

application/json

default

### Unexpected Internal Server Error An unexpected internal error occurred. We apologize for the inconvenience!

application/json

put

PUT /passwordpolicies/{passwordPolicyId} HTTP/1.1
Host: iam.ionos.com
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 209

{
  "id": "70323699-7c28-58e7-9e0c-ff644f6947a5",
  "metadata": {},
  "properties": {
    "description": "Password policy for John Doe.",
    "minLength": 1,
    "minNumberChars": 0,
    "minUpperChars": 0,
    "minLowerChars": 0,
    "minSpecialChars": 0
  }
}

{
  "id": "70323699-7c28-58e7-9e0c-ff644f6947a5",
  "type": "passwordpolicy",
  "href": "/passwordpolicies/70323699-7c28-58e7-9e0c-ff644f6947a5",
  "metadata": {
    "createdDate": "2020-12-10T13:37:50+01:00",
    "createdBy": "ionos:identity:::users/87f9a82e-b28d-49ed-9d04-fba2c0459cd3",
    "createdByUserId": "87f9a82e-b28d-49ed-9d04-fba2c0459cd3",
    "lastModifiedDate": "2020-12-11T13:37:50+01:00",
    "lastModifiedBy": "ionos:identity:::users/87f9a82e-b28d-49ed-9d04-fba2c0459cd3",
    "lastModifiedByUserId": "87f9a82e-b28d-49ed-9d04-fba2c0459cd3",
    "resourceURN": "ionos:<product>:<location>:<contract>:<resource-path>"
  },
  "properties": {
    "description": "Password policy for John Doe.",
    "minLength": 1,
    "minNumberChars": 0,
    "minUpperChars": 0,
    "minLowerChars": 0,
    "minSpecialChars": 0
  }
}

Delete PasswordPolicy

delete

Deletes the specified PasswordPolicy.

Authorizations

Path parameters

passwordPolicyIdstring · uuidRequired

The ID (UUID) of the PasswordPolicy.

Example: 70323699-7c28-58e7-9e0c-ff644f6947a5

Responses

202

Deleting PasswordPolicy was successful.

400

### Bad Request The request send to the API was malformed.

application/json

401

### Unauthorized The request is missing authorization information or the authorization information provided are expired.

application/json

403

### Not Allowed The user issuing the request does not have the needed permissions.

application/json

404

### Not Found The resource that was requested could not be found.

application/json

429

### Too Many Requests The user has sent too many requests in a given amount of time.

application/json

500

### Internal Server Error An internal error occurred. We apologize for the inconvenience!

application/json

503

### Service Unavailable The server is currently unable to handle the request due to a temporary overloading or maintenance of the server.

application/json

default

### Unexpected Internal Server Error An unexpected internal error occurred. We apologize for the inconvenience!

application/json

delete

DELETE /passwordpolicies/{passwordPolicyId} HTTP/1.1
Host: iam.ionos.com
Authorization: Bearer JWT
Accept: */*

No content

PreviousIdentity NextModels

Was this helpful?