Requires the role: | manager |
POST | /users/{Id}/roles/assign |
---|
export class PostOperationUnTenanted<TResponse> implements IPost
{
public constructor(init?: Partial<PostOperationUnTenanted<TResponse>>) { (Object as any).assign(this, init); }
}
export class UserAccountName
{
public firstName?: string;
public lastName?: string;
public constructor(init?: Partial<UserAccountName>) { (Object as any).assign(this, init); }
}
export enum AccountStatus
{
Shadowed = 'Shadowed',
Registered = 'Registered',
}
export class UserAccount implements IIdentifiableResource
{
public name?: UserAccountName;
public displayName?: string;
public email?: string;
public roles?: string[];
public status: AccountStatus;
public defaultOrganisationId?: string;
public id?: string;
public constructor(init?: Partial<UserAccount>) { (Object as any).assign(this, init); }
}
export class AssignRolesResponse
{
public responseStatus?: ResponseStatus;
public userAccount?: UserAccount;
public constructor(init?: Partial<AssignRolesResponse>) { (Object as any).assign(this, init); }
}
export class AssignRolesRequest extends PostOperationUnTenanted<AssignRolesResponse>
{
public id?: string;
public roles?: string[];
public constructor(init?: Partial<AssignRolesRequest>) { super(init); (Object as any).assign(this, init); }
}
TypeScript AssignRolesRequest DTOs
To override the Content-type in your clients, use the HTTP Accept Header, append the .json suffix or ?format=json
To embed the response in a jsonp callback, append ?callback=myCallback
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
POST /users/{Id}/roles/assign HTTP/1.1
Host: staging-api.billiecart.com.au
Accept: application/json
Content-Type: application/json
Content-Length: length
{"id":"String","roles":["String"]}
HTTP/1.1 200 OK Content-Type: application/json Content-Length: length {"responseStatus":{"errorCode":"String","message":"String","stackTrace":"String","errors":[{"errorCode":"String","fieldName":"String","message":"String","meta":{"String":"String"}}],"meta":{"String":"String"}},"userAccount":{"name":{"firstName":"String","lastName":"String"},"displayName":"String","email":"String","roles":["String"],"status":"Shadowed","defaultOrganisationId":"String","id":"String"}}