Jump to

• Request
• Response

Change a Password

post

/api/core/ChangePassword/executeChangePassword

Changes the password as specified in the request body.

Request

There are no request parameters for this operation.

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• NewPassword: string
  The new password.

  Example: ExampleNewPassword
• OldPassword: string
  The old or expired password.

  Example: ExampleOldPassword
• RepeatNewPassword: string
  The new password, repeated.

  Example: ExampleNewPassword
• Username: string
  The user name to change the password for.

  Example: admin

{
    "properties":{
        "NewPassword":{
            "description":"The new password.",
            "type":"string",
            "example":"ExampleNewPassword"
        },
        "RepeatNewPassword":{
            "description":"The new password, repeated.",
            "type":"string",
            "example":"ExampleNewPassword"
        },
        "Username":{
            "description":"The user name to change the password for.",
            "type":"string",
            "example":"admin"
        },
        "OldPassword":{
            "description":"The old or expired password.",
            "type":"string",
            "example":"ExampleOldPassword"
        }
    }
}

Back to Top

Response

Supported Media Types

• application/json

200 Response

Successful operation

Body ()

Root Schema : schema

Match All

Show Source

• object SuccessfulGetOperation
• object type

{
    "allOf":[
        {
            "$ref":"#/components/schemas/SuccessfulGetOperation"
        },
        {
            "type":"object",
            "properties":{
                "data":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/SessionInfoRead"
                    }
                }
            }
        }
    ]
}

Nested Schema : SuccessfulGetOperation

Type: object

Show Source

• message: string
  The response message.

  Example: Loaded 1 entries
• success: boolean
  Whether the operation was a success (true) or a failure (false).

  Example: true

{
    "properties":{
        "success":{
            "description":"Whether the operation was a success (<b>true</b>) or a failure (<b>false</b>).",
            "type":"boolean",
            "example":"true"
        },
        "message":{
            "description":"The response message.",
            "type":"string",
            "example":"Loaded 1 entries"
        }
    },
    "type":"object"
}

Nested Schema : type

Type: object

Show Source

• data: array data

{
    "type":"object",
    "properties":{
        "data":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/SessionInfoRead"
            }
        }
    }
}

Nested Schema : data

Type: array

Show Source

• Array of: object SessionInfoRead

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/SessionInfoRead"
    }
}

Nested Schema : SessionInfoRead

Type: object

Show Source

• EmailAddress: string
  Email Address

  Example: example.email.com
• FullName: string
  The full name of the user.

  Example: Example Name
• Locale: string
  Defines the specific regional and language preferences

  Example: en_US
• PasswordExpiration: integer
  Duration in which password will get expired in seconds from epoch time

  Example: 2147483647
• PermissionIDs: object PermissionIDs
  An object having ids of all the permissions that the user has
• Permissions: object Permissions
  An object having sub-objects each of which shows permissions like create, update, delete available to the user for each endpoint
• Preferences: object Preferences
  An object showing the user preferences
• Properties: object Properties
  An object showing restrictive property IDs
• SamlUser: boolean
  Whether the User is a Saml User

  Example: false
• SupportPassword: string
  Support Password

  Example: example password
• SupportUsername: string
  Support Username

  Example: example username
• ThemeDir: string
  Theme selected by the user

  Example: light
• TZ: string
  Time Zone represented in an abbreviated format also depicting offset from UTC.

  Example: CST6CDT
• UserGroupID: integer
  The user group ID.

  Example: 1
• UserID: integer
  The user ID.

  Example: 1001
• Username: string
  Username

  Example: admin

{
    "properties":{
        "UserID":{
            "description":"The user ID.",
            "type":"integer",
            "example":"1001"
        },
        "UserGroupID":{
            "description":"The user group ID.",
            "type":"integer",
            "example":"1"
        },
        "Username":{
            "description":"Username",
            "type":"string",
            "example":"admin"
        },
        "FullName":{
            "description":"The full name of the user.",
            "type":"string",
            "example":"Example Name"
        },
        "PasswordExpiration":{
            "description":"Duration in which password will get expired in seconds from epoch time",
            "type":"integer",
            "example":"2147483647"
        },
        "SupportUsername":{
            "description":"Support Username",
            "type":"string",
            "example":"example username"
        },
        "SupportPassword":{
            "description":"Support Password",
            "type":"string",
            "example":"example password"
        },
        "EmailAddress":{
            "description":"Email Address",
            "type":"string",
            "example":"example.email.com"
        },
        "SamlUser":{
            "description":"Whether the User is a Saml User",
            "type":"boolean",
            "example":false
        },
        "PermissionIDs":{
            "description":"An object having ids of all the permissions that the user has",
            "type":"object",
            "example":{
                "AAAAuthTypes":"10021",
                "brokerServices":"11008"
            }
        },
        "Permissions":{
            "description":"An object having sub-objects each of which shows permissions like create, update, delete available to the user for each endpoint",
            "type":"object",
            "example":{
                "AAA":{
                    "AuthTypes":{
                        "read":true,
                        "create":false
                    },
                    "Permissions":{
                        "read":true,
                        "create":false
                    }
                }
            }
        },
        "Preferences":{
            "description":"An object showing the user preferences",
            "type":"object",
            "example":{
                "PageSize":"1000",
                "RefreshRate":"60"
            }
        },
        "ThemeDir":{
            "description":"Theme selected by the user",
            "type":"string",
            "example":"light"
        },
        "Locale":{
            "description":"Defines the specific regional and language preferences",
            "type":"string",
            "example":"en_US"
        },
        "Properties":{
            "description":"An object showing restrictive property IDs",
            "type":"object",
            "example":{
                "RestrictiveDeviceGroupId":"1"
            }
        },
        "TZ":{
            "description":"Time Zone represented in an abbreviated format also depicting offset from UTC.",
            "type":"string",
            "example":"CST6CDT"
        }
    }
}

Nested Schema : PermissionIDs

Type: object

An object having ids of all the permissions that the user has

Example:

{
    "AAAAuthTypes":"10021",
    "brokerServices":"11008"
}

Nested Schema : Permissions

Type: object

An object having sub-objects each of which shows permissions like create, update, delete available to the user for each endpoint

Example:

{
    "AAA":{
        "AuthTypes":{
            "read":true,
            "create":false
        },
        "Permissions":{
            "read":true,
            "create":false
        }
    }
}

Nested Schema : Preferences

Type: object

An object showing the user preferences

Example:

{
    "PageSize":"1000",
    "RefreshRate":"60"
}

Nested Schema : Properties

Type: object

An object showing restrictive property IDs

Example:

{
    "RestrictiveDeviceGroupId":"1"
}

Default Response

Failed operation

Body ()

Root Schema : schema

Type: object

Show Source

• errors: array errors
  The list of errors reported. Validation errors will be keyed by record field.
• message: string
  The response message.

  Example: Exception thrown
• success: boolean
  Whether the operation was a success (true) or a failure (false).

  Example: false

{
    "properties":{
        "success":{
            "description":"Whether the operation was a success (<b>true</b>) or a failure (<b>false</b>).",
            "type":"boolean",
            "example":"false"
        },
        "message":{
            "description":"The response message.",
            "type":"string",
            "example":"Exception thrown"
        },
        "errors":{
            "description":"The list of errors reported. Validation errors will be keyed by record field.",
            "type":"array",
            "items":{
                "type":"object"
            }
        }
    },
    "type":"object"
}

Nested Schema : errors

Type: array

The list of errors reported. Validation errors will be keyed by record field.

Show Source

• Array of: object items

{
    "description":"The list of errors reported. Validation errors will be keyed by record field.",
    "type":"array",
    "items":{
        "type":"object"
    }
}

Nested Schema : items

Type: object

Back to Top