Jump to

• Request
• Response

Create a User

post

/api/AAA/Users

Creates a new user.

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

• AccountExpiration: string
  Indicates whether a password will expire or not Allowed Values: | [Never] => User's password never expires | immediate => Administrator forced immediate change for this password - user will be required to change at next login | date => User's password will/did expire on the specified $PasswordExpiration date. This value requires $PasswordExpiration to be set.

  Example: [Never]
• AccountStatus: string
  A flag to indicate if the user account is enabled or disabled. Values- 0 = Disabled, 1 = Enabled

  Example: 1
• AuthenticationType: integer
  Unique identifier for the authentication type.

  Example: 1
• EmailAddress: string
  The user email address.

  Example: example@t.c
• FullName: string
  The full name of the user.

  Example: Operator
• Password: string
  Required for Internal authentication only

  Example:
• PasswordChange: string
  Indicates date when the current password will expire (Optional) Allowed Values: YYYY-MM-DD => User's password will/did expire on this date

  Example: date
• PasswordExpiration: string
  Indicates date when the current password will expire (Optional) Allowed Values: YYYY-MM-DD => User's password will/did expire on this date

  Example: 2147483647
• Preferences: array Preferences
  The user preferences.
• Properties: array Properties
  Properties
• RepeatPassword: string
  Required for Internal authentication only

  Example:
• SupportPassword: string
  Assure1 Support Site Password

  Example:
• SupportUsername: string
  Support User name

  Example:
• UserGroup: integer
  Unique identifier for the user group.

  Example: 1
• UserName: string
  The user name.

  Example: operator

{
    "properties":{
        "UserName":{
            "description":"The user name.",
            "type":"string",
            "example":"operator"
        },
        "FullName":{
            "description":"The full name of the user.",
            "type":"string",
            "example":"Operator"
        },
        "EmailAddress":{
            "description":"The user email address.",
            "type":"string",
            "example":"example@t.c"
        },
        "AuthenticationType":{
            "description":"Unique identifier for the authentication type.",
            "type":"integer",
            "example":1
        },
        "Password":{
            "description":"Required for Internal authentication only",
            "type":"string",
            "example":""
        },
        "RepeatPassword":{
            "description":"Required for Internal authentication only",
            "type":"string",
            "example":""
        },
        "PasswordChange":{
            "description":"Indicates date when the current password will expire (Optional)\nAllowed Values:\nYYYY-MM-DD => User's password will/did expire on this date",
            "type":"string",
            "example":"date"
        },
        "PasswordExpiration":{
            "description":"Indicates date when the current password will expire (Optional)\nAllowed Values:\nYYYY-MM-DD => User's password will/did expire on this date",
            "type":"string",
            "example":"2147483647"
        },
        "UserGroup":{
            "description":"Unique identifier for the user group.",
            "type":"integer",
            "example":1
        },
        "AccountExpiration":{
            "description":"Indicates whether a password will expire or not\nAllowed Values:\n| [Never]     => User's password never expires\n| immediate => Administrator forced immediate change for this password - user will be required to change at next login\n| date      => User's password will/did expire on the specified $PasswordExpiration date. This value requires $PasswordExpiration to be set.",
            "type":"string",
            "example":"[Never]"
        },
        "AccountStatus":{
            "description":"A flag to indicate if the user account is enabled or disabled. Values- 0 = Disabled, 1 = Enabled",
            "type":"string",
            "example":"1"
        },
        "SupportUsername":{
            "description":"Support User name",
            "type":"string",
            "example":""
        },
        "SupportPassword":{
            "description":"Assure1 Support Site Password",
            "type":"string",
            "example":""
        },
        "Properties":{
            "description":"Properties",
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "PropertyID":{
                        "description":"Property ID",
                        "type":"integer",
                        "example":"1"
                    },
                    "PreferenceName":{
                        "description":"Property Name",
                        "type":"string",
                        "example":"ResetQuestion"
                    },
                    "PreferenceValue":{
                        "description":"Property Value",
                        "type":"string",
                        "example":"resetval"
                    },
                    "Description":{
                        "description":"Description associated with the Property.",
                        "type":"string",
                        "example":"Reserved for future use"
                    },
                    "id":{
                        "type":"integer",
                        "example":2
                    }
                }
            }
        },
        "Preferences":{
            "description":"The user preferences.",
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "PreferenceID":{
                        "description":"The preference ID.",
                        "type":"integer",
                        "example":"3"
                    },
                    "PreferenceName":{
                        "description":"The preference name.",
                        "type":"string",
                        "example":"DefaultDisplayID"
                    },
                    "PreferenceValue":{
                        "description":"The preference value.",
                        "type":"integer",
                        "example":"5"
                    },
                    "Description":{
                        "description":"The preference description.",
                        "type":"string",
                        "example":"Default event list display (default "Default")"
                    },
                    "Override":{
                        "type":"integer",
                        "example":"0"
                    },
                    "id":{
                        "type":"integer",
                        "example":1
                    }
                }
            }
        }
    }
}

Nested Schema : Preferences

Type: array

The user preferences.

Show Source

• Array of: object items

{
    "description":"The user preferences.",
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "PreferenceID":{
                "description":"The preference ID.",
                "type":"integer",
                "example":"3"
            },
            "PreferenceName":{
                "description":"The preference name.",
                "type":"string",
                "example":"DefaultDisplayID"
            },
            "PreferenceValue":{
                "description":"The preference value.",
                "type":"integer",
                "example":"5"
            },
            "Description":{
                "description":"The preference description.",
                "type":"string",
                "example":"Default event list display (default "Default")"
            },
            "Override":{
                "type":"integer",
                "example":"0"
            },
            "id":{
                "type":"integer",
                "example":1
            }
        }
    }
}

Nested Schema : Properties

Type: array

Properties

Show Source

• Array of: object items

{
    "description":"Properties",
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "PropertyID":{
                "description":"Property ID",
                "type":"integer",
                "example":"1"
            },
            "PreferenceName":{
                "description":"Property Name",
                "type":"string",
                "example":"ResetQuestion"
            },
            "PreferenceValue":{
                "description":"Property Value",
                "type":"string",
                "example":"resetval"
            },
            "Description":{
                "description":"Description associated with the Property.",
                "type":"string",
                "example":"Reserved for future use"
            },
            "id":{
                "type":"integer",
                "example":2
            }
        }
    }
}

Nested Schema : items

Type: object

Show Source

• Description: string
  The preference description.

  Example: Default event list display (default "Default")
• id: integer
  Example: 1
• Override: integer
  Example: 0
• PreferenceID: integer
  The preference ID.

  Example: 3
• PreferenceName: string
  The preference name.

  Example: DefaultDisplayID
• PreferenceValue: integer
  The preference value.

  Example: 5

{
    "type":"object",
    "properties":{
        "PreferenceID":{
            "description":"The preference ID.",
            "type":"integer",
            "example":"3"
        },
        "PreferenceName":{
            "description":"The preference name.",
            "type":"string",
            "example":"DefaultDisplayID"
        },
        "PreferenceValue":{
            "description":"The preference value.",
            "type":"integer",
            "example":"5"
        },
        "Description":{
            "description":"The preference description.",
            "type":"string",
            "example":"Default event list display (default "Default")"
        },
        "Override":{
            "type":"integer",
            "example":"0"
        },
        "id":{
            "type":"integer",
            "example":1
        }
    }
}

Nested Schema : items

Type: object

Show Source

• Description: string
  Description associated with the Property.

  Example: Reserved for future use
• id: integer
  Example: 2
• PreferenceName: string
  Property Name

  Example: ResetQuestion
• PreferenceValue: string
  Property Value

  Example: resetval
• PropertyID: integer
  Property ID

  Example: 1

{
    "type":"object",
    "properties":{
        "PropertyID":{
            "description":"Property ID",
            "type":"integer",
            "example":"1"
        },
        "PreferenceName":{
            "description":"Property Name",
            "type":"string",
            "example":"ResetQuestion"
        },
        "PreferenceValue":{
            "description":"Property Value",
            "type":"string",
            "example":"resetval"
        },
        "Description":{
            "description":"Description associated with the Property.",
            "type":"string",
            "example":"Reserved for future use"
        },
        "id":{
            "type":"integer",
            "example":2
        }
    }
}

Back to Top

Response

Supported Media Types

• application/json

200 Response

Successful operation

Body ()

Root Schema : schema

Match All

Show Source

• object SuccessfulAddOperation
• object type

{
    "allOf":[
        {
            "$ref":"#/components/schemas/SuccessfulAddOperation"
        },
        {
            "type":"object",
            "properties":{
                "total":{
                    "description":"The total number of results regardless of paging.",
                    "type":"integer",
                    "example":"1"
                },
                "data":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/AAAUsersRead"
                    }
                }
            }
        }
    ]
}

Nested Schema : SuccessfulAddOperation

Type: object

Show Source

• message: string
  The response message.

  Example: Added record
• 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":"Added record"
        }
    },
    "type":"object"
}

Nested Schema : type

Type: object

Show Source

• data: array data
• total: integer
  The total number of results regardless of paging.

  Example: 1

{
    "type":"object",
    "properties":{
        "total":{
            "description":"The total number of results regardless of paging.",
            "type":"integer",
            "example":"1"
        },
        "data":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/AAAUsersRead"
            }
        }
    }
}

Nested Schema : data

Type: array

Show Source

• Array of: object AAAUsersRead

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

Nested Schema : AAAUsersRead

Type: object

Show Source

• AccountExpiration: string
  Indicates whether a password will expire or not Allowed Values: | [Never] => User's password never expires | immediate => Administrator forced immediate change for this password - user will be required to change at next login | date => User's password will/did expire on the specified $PasswordExpiration date. This value requires $PasswordExpiration to be set.

  Example: [Never]
• AccountStatus: integer
  A flag to indicate if the user account is enabled or disabled. Values- 0 = Disabled, 1 = Enabled

  Example: 1
• AuthenticationType: object AuthenticationType
  The authentication type.
• AuthenticationTypeName: string
  The authentication type name.

  Example: Internal
• EmailAddress: string
  The user email address.

  Example: example@t.c
• FailedLoginCount: integer
  The number of failed logins.

  Example: 0
• FullName: string
  The full name of the user.

  Example: Operator
• LastLoginFailed: integer
  Last Login Failed

  Example: 0
• LastLoginSuccess: integer
  Last Login Success

  Example: 0
• Password: string
  Required for Internal authentication only

  Example:
• PasswordExpiration: string
  The expiration date of the current password (in YYYYMMDD format).

  Example: 2147483647
• Preferences: array Preferences
  The user preferences.
• Properties: array Properties
  Properties
• RepeatPassword: string
  Required for Internal authentication only

  Example:
• SupportUsername: string
  Support User name

  Example:
• UserGroup: object UserGroup
  The user group.
• UserGroupName: string
  The user group name.

  Example: Administrators
• UserID: integer
  The user ID.

  Example: 1065
• UserName: string
  The user name.

  Example: operator

{
    "properties":{
        "UserID":{
            "description":"The user ID.",
            "type":"integer",
            "example":"1065"
        },
        "UserName":{
            "description":"The user name.",
            "type":"string",
            "example":"operator"
        },
        "FullName":{
            "description":"The full name of the user.",
            "type":"string",
            "example":"Operator"
        },
        "EmailAddress":{
            "description":"The user email address.",
            "type":"string",
            "example":"example@t.c"
        },
        "LastLoginSuccess":{
            "description":"Last Login Success",
            "type":"integer",
            "example":"0"
        },
        "LastLoginFailed":{
            "description":"Last Login Failed",
            "type":"integer",
            "example":"0"
        },
        "PasswordExpiration":{
            "description":"The expiration date of the current password (in YYYYMMDD format).",
            "type":"string",
            "example":"2147483647"
        },
        "AccountExpiration":{
            "description":"Indicates whether a password will expire or not\nAllowed Values:\n| [Never]     => User's password never expires\n| immediate => Administrator forced immediate change for this password - user will be required to change at next login\n| date      => User's password will/did expire on the specified $PasswordExpiration date. This value requires $PasswordExpiration to be set.",
            "type":"string",
            "example":"[Never]"
        },
        "FailedLoginCount":{
            "description":"The number of failed logins.",
            "type":"integer",
            "example":"0"
        },
        "AuthenticationType":{
            "description":"The authentication type.",
            "type":"object",
            "properties":{
                "id":{
                    "description":"Unique identifier for the authentication type.",
                    "type":"integer"
                },
                "name":{
                    "description":"Name for the authentication type.",
                    "type":"string"
                }
            },
            "example":{
                "id":"1",
                "name":"Internal"
            }
        },
        "AccountStatus":{
            "description":"A flag to indicate if the user account is enabled or disabled. Values- 0 = Disabled, 1 = Enabled",
            "type":"integer",
            "example":"1"
        },
        "SupportUsername":{
            "description":"Support User name",
            "type":"string",
            "example":""
        },
        "UserGroupName":{
            "description":"The user group name.",
            "type":"string",
            "example":"Administrators"
        },
        "AuthenticationTypeName":{
            "description":"The authentication type name.",
            "type":"string",
            "example":"Internal"
        },
        "UserGroup":{
            "description":"The user group.",
            "type":"object",
            "properties":{
                "id":{
                    "description":"Unique identifier for the user group.",
                    "type":"integer"
                },
                "name":{
                    "description":"Name for the user group.",
                    "type":"string"
                }
            },
            "example":{
                "id":"1",
                "name":"Administrators"
            }
        },
        "Password":{
            "description":"Required for Internal authentication only",
            "type":"string",
            "example":""
        },
        "RepeatPassword":{
            "description":"Required for Internal authentication only",
            "type":"string",
            "example":""
        },
        "Properties":{
            "description":"Properties",
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "PropertyID":{
                        "description":"Property ID",
                        "type":"integer",
                        "example":"1"
                    },
                    "PreferenceName":{
                        "description":"Property Name",
                        "type":"string",
                        "example":"ResetQuestion"
                    },
                    "PreferenceValue":{
                        "description":"Property Value",
                        "type":"string",
                        "example":"resetval"
                    },
                    "Description":{
                        "description":"Description associated with the Property.",
                        "type":"string",
                        "example":"Reserved for future use"
                    }
                }
            }
        },
        "Preferences":{
            "description":"The user preferences.",
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "PreferenceID":{
                        "description":"The preference ID.",
                        "type":"integer",
                        "example":"3"
                    },
                    "PreferenceName":{
                        "description":"The preference name.",
                        "type":"string",
                        "example":"DefaultDisplayID"
                    },
                    "PreferenceValue":{
                        "description":"The preference value.",
                        "type":"string",
                        "example":"5"
                    },
                    "Description":{
                        "description":"The preference description.",
                        "type":"string",
                        "example":"Default event list display (default "Default")"
                    },
                    "Override":{
                        "description":"This flag indicates if the user's group preference overrides the user's specific preference.",
                        "type":"integer",
                        "example":0
                    }
                }
            }
        }
    }
}

Nested Schema : AuthenticationType

Type: object

The authentication type.

Show Source

• id: integer
  Unique identifier for the authentication type.
• name: string
  Name for the authentication type.

{
    "description":"The authentication type.",
    "type":"object",
    "properties":{
        "id":{
            "description":"Unique identifier for the authentication type.",
            "type":"integer"
        },
        "name":{
            "description":"Name for the authentication type.",
            "type":"string"
        }
    },
    "example":{
        "id":"1",
        "name":"Internal"
    }
}

Example:

{
    "id":"1",
    "name":"Internal"
}

Nested Schema : Preferences

Type: array

The user preferences.

Show Source

• Array of: object items

{
    "description":"The user preferences.",
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "PreferenceID":{
                "description":"The preference ID.",
                "type":"integer",
                "example":"3"
            },
            "PreferenceName":{
                "description":"The preference name.",
                "type":"string",
                "example":"DefaultDisplayID"
            },
            "PreferenceValue":{
                "description":"The preference value.",
                "type":"string",
                "example":"5"
            },
            "Description":{
                "description":"The preference description.",
                "type":"string",
                "example":"Default event list display (default "Default")"
            },
            "Override":{
                "description":"This flag indicates if the user's group preference overrides the user's specific preference.",
                "type":"integer",
                "example":0
            }
        }
    }
}

Nested Schema : Properties

Type: array

Properties

Show Source

• Array of: object items

{
    "description":"Properties",
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "PropertyID":{
                "description":"Property ID",
                "type":"integer",
                "example":"1"
            },
            "PreferenceName":{
                "description":"Property Name",
                "type":"string",
                "example":"ResetQuestion"
            },
            "PreferenceValue":{
                "description":"Property Value",
                "type":"string",
                "example":"resetval"
            },
            "Description":{
                "description":"Description associated with the Property.",
                "type":"string",
                "example":"Reserved for future use"
            }
        }
    }
}

Nested Schema : UserGroup

Type: object

The user group.

Show Source

• id: integer
  Unique identifier for the user group.
• name: string
  Name for the user group.

{
    "description":"The user group.",
    "type":"object",
    "properties":{
        "id":{
            "description":"Unique identifier for the user group.",
            "type":"integer"
        },
        "name":{
            "description":"Name for the user group.",
            "type":"string"
        }
    },
    "example":{
        "id":"1",
        "name":"Administrators"
    }
}

Example:

{
    "id":"1",
    "name":"Administrators"
}

Nested Schema : items

Type: object

Show Source

• Description: string
  The preference description.

  Example: Default event list display (default "Default")
• Override: integer
  This flag indicates if the user's group preference overrides the user's specific preference.

  Example: 0
• PreferenceID: integer
  The preference ID.

  Example: 3
• PreferenceName: string
  The preference name.

  Example: DefaultDisplayID
• PreferenceValue: string
  The preference value.

  Example: 5

{
    "type":"object",
    "properties":{
        "PreferenceID":{
            "description":"The preference ID.",
            "type":"integer",
            "example":"3"
        },
        "PreferenceName":{
            "description":"The preference name.",
            "type":"string",
            "example":"DefaultDisplayID"
        },
        "PreferenceValue":{
            "description":"The preference value.",
            "type":"string",
            "example":"5"
        },
        "Description":{
            "description":"The preference description.",
            "type":"string",
            "example":"Default event list display (default "Default")"
        },
        "Override":{
            "description":"This flag indicates if the user's group preference overrides the user's specific preference.",
            "type":"integer",
            "example":0
        }
    }
}

Nested Schema : items

Type: object

Show Source

• Description: string
  Description associated with the Property.

  Example: Reserved for future use
• PreferenceName: string
  Property Name

  Example: ResetQuestion
• PreferenceValue: string
  Property Value

  Example: resetval
• PropertyID: integer
  Property ID

  Example: 1

{
    "type":"object",
    "properties":{
        "PropertyID":{
            "description":"Property ID",
            "type":"integer",
            "example":"1"
        },
        "PreferenceName":{
            "description":"Property Name",
            "type":"string",
            "example":"ResetQuestion"
        },
        "PreferenceValue":{
            "description":"Property Value",
            "type":"string",
            "example":"resetval"
        },
        "Description":{
            "description":"Description associated with the Property.",
            "type":"string",
            "example":"Reserved for future use"
        }
    }
}

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