REL documentation
Resource:a master loginC# Rel Const:Rels.MasterSvc.LoginURI template:logins/{id}Obtain URI from:
Get a single login
Success status: 200; ETag response header supplied
| Name (* = required) | Data Type | Description |
|---|---|---|
| id * | int | login id |
| Type | Description | |
|---|---|---|
| User | string | |
| NewPassword | string | |
| Deactivated | bool | |
| Links | IList<WebApi.Hal.Link> | |
| - edit |
{
"user": "str",
"newPassword": "str",
"deactivated": true
}
update a login
If-Match request header required; Success status: 200; ETag response header supplied
| Name (* = required) | Data Type | Description |
|---|---|---|
| id * | int | login id |
| Type | Description | |
|---|---|---|
| User | string | |
| NewPassword | string | |
| Deactivated | bool |
Sample content-type: application/hal+json |
{
"user": "str",
"newPassword": "str",
"deactivated": true
}
| Type | Description | |
|---|---|---|
| User | string | |
| NewPassword | string | |
| Deactivated | bool | |
| Links | IList<WebApi.Hal.Link> | |
| - edit |
{
"user": "str",
"newPassword": "str",
"deactivated": true
}
delete a login
If-Match request header required; Success status: 204
| Name (* = required) | Data Type | Description |
|---|---|---|
| id * | int | login id |
This documentation is subject to change, and is updated often and without warning. The models documented may or may not be available to users now or in the future. Use this documentation at your own risk.
Contact api@3plcentral.com with any questions about this documentation.