API docs by Redocly

IONOS Cloud - IAM Identity Password Policies API (1.0.0)

Download OpenAPI specification:Download

API for managing Password Policies.

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

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

Authorizations:
tokenAuth
query Parameters
effectivePolicy
boolean

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.

Responses

Response samples

Content type
application/json
{
  • "id": "95f76a5e-86cd-52e0-b080-f22f131718e5",
  • "type": "collection",
  • "href": "/passwordpolicies",
  • "items": [
    ]
}

Create PasswordPolicy

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:
tokenAuth
Request Body schema: application/json

PasswordPolicy to create.

object

Metadata

required
object (PasswordPolicy)

Responses

Request samples

Content type
application/json
{
  • "metadata": { },
  • "properties": {
    }
}

Response samples

Content type
application/json
{
  • "id": "70323699-7c28-58e7-9e0c-ff644f6947a5",
  • "type": "passwordpolicy",
  • "href": "/passwordpolicies/70323699-7c28-58e7-9e0c-ff644f6947a5",
  • "metadata": {
    },
  • "properties": {
    }
}

Retrieve PasswordPolicy

Returns the PasswordPolicy by ID.

Authorizations:
tokenAuth
path Parameters
passwordPolicyId
required
string <uuid>
Example: 70323699-7c28-58e7-9e0c-ff644f6947a5

The ID (UUID) of the PasswordPolicy.

Responses

Response samples

Content type
application/json
{
  • "id": "70323699-7c28-58e7-9e0c-ff644f6947a5",
  • "type": "passwordpolicy",
  • "href": "/passwordpolicies/70323699-7c28-58e7-9e0c-ff644f6947a5",
  • "metadata": {
    },
  • "properties": {
    }
}

Ensure PasswordPolicy

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:
tokenAuth
path Parameters
passwordPolicyId
required
string <uuid>
Example: 70323699-7c28-58e7-9e0c-ff644f6947a5

The ID (UUID) of the PasswordPolicy.

Request Body schema: application/json

update PasswordPolicy

id
required
string <uuid>

The ID (UUID) of the PasswordPolicy.

object

Metadata

required
object (PasswordPolicy)

Responses

Request samples

Content type
application/json
{
  • "id": "70323699-7c28-58e7-9e0c-ff644f6947a5",
  • "metadata": { },
  • "properties": {
    }
}

Response samples

Content type
application/json
{
  • "id": "70323699-7c28-58e7-9e0c-ff644f6947a5",
  • "type": "passwordpolicy",
  • "href": "/passwordpolicies/70323699-7c28-58e7-9e0c-ff644f6947a5",
  • "metadata": {
    },
  • "properties": {
    }
}

Delete PasswordPolicy

Deletes the specified PasswordPolicy.

Authorizations:
tokenAuth
path Parameters
passwordPolicyId
required
string <uuid>
Example: 70323699-7c28-58e7-9e0c-ff644f6947a5

The ID (UUID) of the PasswordPolicy.

Responses

Response samples

Content type
application/json
{
  • "httpStatus": 400,
  • "messages": [
    ]
}