Connector Appliance APIs

Change the administrator user password for the Connector Appliance

July 27, 2023

Contributed by:

M C

To change the administrator user password, you need the following items:

Only the username admin is supported in the current version of Connector Appliance. The username is case sensitive.
The current password.
A valid authorization token. For instructions on how to aquire an authorization token , refer to Getting started.

Change password request

To change the administrator user password, send a POST request to the /$changePassword endpoint of the Connector Appliance. The username is always admin.

Request

POST /$changePassword HTTP/1.1
Content-Type: application/json
Accept: */*
Authorization: Bearer <token>
Host: <connector-appliance-ip-address>
Content-Length: <length>

{
    "username": "admin",
    "currentPassword": "",
    "newPassword": ""
}
<!--NeedCopy-->

Responses

Success

When successful, the Connector Appliance returns HTTP status code 204.

HTTP/1.1 204 No Content
Cache-Control: no-cache, no-store
Citrix-Transactionid: <id>
Content-Length: <length>
Content-Security-Policy: frame-ancestors 'none'
Content-Type: application/json; charset=utf-8
Date: <date>
X-Content-Type-Options: nosniff
X-Frame-Options: deny
<!--NeedCopy-->

Failures

Invalid authorization token

The Connector Appliance produces the following response when the authorization token in the request header is invalid.

HTTP/1.1 401 Unauthorized
Cache-Control: no-cache, no-store
Citrix-Transactionid: <id>
Content-Length: <length>
Content-Security-Policy: frame-ancestors 'none'
Content-Type: application/json; charset=utf-8
Date: <date>
X-Content-Type-Options: nosniff
X-Frame-Options: deny

{
    "type": "https://errors-api.cloud.com/common/authentication",
    "detail": "Invalid authentication details",
    "parameters": [{
        "name": "reason",
        "value": "invalid"
    }]
}
<!--NeedCopy-->

Missing authorization token

The Connector Appliance produces the following response when the authorization token is missing from the request header.

HTTP/1.1 401 Unauthorized
Cache-Control: no-cache, no-store
Citrix-Transactionid: <id>
Content-Length: <length>
Content-Security-Policy: frame-ancestors 'none'
Content-Type: application/json; charset=utf-8
Date: <date>
X-Content-Type-Options: nosniff
X-Frame-Options: deny

{
    "type": "https://errors-api.cloud.com/common/authentication",
    "detail": "Missing authentication details",
    "parameters": [{
        "name": "reason",
        "value": "missing"
    }]
}
<!--NeedCopy-->

Incorrect username

The Connector Appliance produces the following response when the provided username is anything other than ‘admin’.

HTTP/1.1 400 Bad Request
Cache-Control: no-cache, no-store
Citrix-Transactionid: <id>
Content-Length: <length>
Content-Security-Policy: frame-ancestors 'none'
Content-Type: application/json; charset=utf-8
Date: <date>
X-Content-Type-Options: nosniff
X-Frame-Options: deny

{
    "type": "https://errors-api.cloud.com/common/invalidString",
    "detail": "Field \"username\" has an invalid value.",
    "parameters": [{
        "name": "property",
        "value": "username"
    }]
}
<!--NeedCopy-->

Missing username

The Connector Appliance produces the following response when the username is missing from the request body.

HTTP/1.1 400 Bad Request
Cache-Control: no-cache, no-store
Citrix-Transactionid: <id>
Content-Length: <length>
Content-Security-Policy: frame-ancestors 'none'
Content-Type: application/json; charset=utf-8
Date: <date>
X-Content-Type-Options: nosniff
X-Frame-Options: deny

{
    "type": "https://errors-api.cloud.com/common/missing",
    "detail": "Field \"username\" is missing.",
    "parameters": [{
        "name": "property",
        "value": "username"
    }]
}
<!--NeedCopy-->

Missing current password

The Connector Appliance produces the following response when the current password is missing from the request body.

HTTP/1.1 400 Bad Request
Cache-Control: no-cache, no-store
Citrix-Transactionid: <id>
Content-Length: <length>
Content-Security-Policy: frame-ancestors 'none'
Content-Type: application/json; charset=utf-8
Date: <date>
X-Content-Type-Options: nosniff
X-Frame-Options: deny

{
    "type": "https://errors-api.cloud.com/common/missing",
    "detail": "Field \"currentPassword\" is missing.",
    "parameters": [{
        "name": "property",
        "value": "currentPassword"
    }]
}
<!--NeedCopy-->

Invalid current password

The Connector Appliance produces the following response when the current password is invalid.

HTTP/1.1 403 Forbidden
Cache-Control: no-cache, no-store
Citrix-Transactionid: <id>
Content-Length: <length>
Content-Security-Policy: frame-ancestors 'none'
Content-Type: application/json; charset=utf-8
Date: <date>
X-Content-Type-Options: nosniff
X-Frame-Options: deny

{
    "type": "https://errors-api.cloud.com/common/authorization",
    "detail": "Authorization error"
}
<!--NeedCopy-->

Invalid new password

The Connector Appliance produces the following response when the new password does not meet the strength requirement.

HTTP/1.1 400 Bad Request
Cache-Control: no-cache, no-store
Citrix-Transactionid: <id>
Content-Length: <length>
Content-Security-Policy: frame-ancestors 'none'
Content-Type: application/json; charset=utf-8
Date: <date>
X-Content-Type-Options: nosniff
X-Frame-Options: deny

{
    "type": "https://errors-api.cloud.com/common/invalidString",
    "detail": "Field \"newPassword\" has an invalid value.",
    "parameters": [{
        "name": "property",
        "value": "newPassword"
    }]
}
<!--NeedCopy-->

Empty new password

The Connector Appliance produces the following response when the new password is missing.

HTTP/1.1 400 Bad Request
Cache-Control: no-cache, no-store
Citrix-Transactionid: <id>
Content-Length: <length>
Content-Security-Policy: frame-ancestors 'none'
Content-Type: application/json; charset=utf-8
Date: <date>
X-Content-Type-Options: nosniff
X-Frame-Options: deny

{
    "type": "https://errors-api.cloud.com/common/missing",
    "detail": "Field \"newPassword\" is missing.",
    "parameters": [{
        "name": "property",
        "value": "newPassword"
    }]
}
<!--NeedCopy-->

New password is the same as the old password

The Connector Appliance produces the following response when the new password is the same as the old password.

HTTP/1.1 409 Conflict
Cache-Control: no-cache, no-store
Citrix-Transactionid: <id>
Content-Length: <length>
Content-Security-Policy: frame-ancestors 'none'
Content-Type: application/json; charset=utf-8
Date: <date>
X-Content-Type-Options: nosniff
X-Frame-Options: deny

{
    "type": "https://errors-api.cloud.com/connapp/conflict",
    "detail": "AUDIT: Change password failed because old and new password are the same for user [username]"
}
<!--NeedCopy-->

The official version of this content is in English. Some of the Cloud Software Group documentation content is machine translated for your convenience only. Cloud Software Group has no control over machine-translated content, which may contain errors, inaccuracies or unsuitable language. No warranty of any kind, either expressed or implied, is made as to the accuracy, reliability, suitability, or correctness of any translations made from the English original into any other language, or that your Cloud Software Group product or service conforms to any machine translated content, and any warranty provided under the applicable end user license agreement or terms of service, or any other agreement with Cloud Software Group, that the product or service conforms with any documentation shall not apply to the extent that such documentation has been machine translated. Cloud Software Group will not be held responsible for any damage or issues that may arise from using machine-translated content.

Was this helpful

Resources

Connector Appliance APIs OpenAPI Specification

Copy Download

Change the administrator user password for the Connector Appliance

July 27, 2023

Contributed by:

M C

July 27, 2023

Contributed by:

M C

Change the administrator user password for the Connector Appliance

Change password request

Request

Responses

Success

Failures

Invalid authorization token

Missing authorization token

Incorrect username

Missing username

Missing current password

Invalid current password

Invalid new password

Empty new password

New password is the same as the old password

Resources

Connector Appliance APIs OpenAPI Specification

In this article

Resources

Connector Appliance APIs OpenAPI Specification