Foundry API

AssignUserRolesRequest

The following routes are available for this service:
POST	/users/{Id}/roles/assign


export class PostOperationUnTenanted<TResponse> implements IPost
{

    public constructor(init?: Partial<PostOperationUnTenanted<TResponse>>) { (Object as any).assign(this, init); }
}

export enum AccountStatus
{
    Shadowed = 'Shadowed',
    Registered = 'Registered',
}

export enum AccountType
{
    Person = 'Person',
    Machine = 'Machine',
}

export class UserAccount implements IIdentifiableResource
{
    public roles?: string[];
    public status: AccountStatus;
    public defaultOrganisationId?: string;
    public type: AccountType;
    public id?: string;

    public constructor(init?: Partial<UserAccount>) { (Object as any).assign(this, init); }
}

export class AssignUserRolesResponse
{
    public responseStatus?: ResponseStatus;
    public userAccount?: UserAccount;

    public constructor(init?: Partial<AssignUserRolesResponse>) { (Object as any).assign(this, init); }
}

export class AssignUserRolesRequest extends PostOperationUnTenanted<AssignUserRolesResponse>
{
    public id?: string;
    public roles?: string[];

    public constructor(init?: Partial<AssignUserRolesRequest>) { super(init); (Object as any).assign(this, init); }
}

TypeScript AssignUserRolesRequest DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .csv suffix or ?format=csv

HTTP + CSV

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: foundrystage-api-app.azurewebsites.net 
Accept: text/csv
Content-Type: text/csv
Content-Length: length

{"id":"String","roles":["String"]}

HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length

{"responseStatus":{"errorCode":"String","message":"String","stackTrace":"String","errors":[{"errorCode":"String","fieldName":"String","message":"String","meta":{"String":"String"}}],"meta":{"String":"String"}},"userAccount":{"roles":["String"],"status":"Shadowed","defaultOrganisationId":"String","type":"Person","id":"String"}}