Foundry API

<back to all web services

UnassignUserRolesRequest

Requires Authentication
The following routes are available for this service:
DELETE/users/{Id}/roles/unassign
import 'package:servicestack/servicestack.dart';

abstract class DeleteOperationUnTenanted<TResponse> implements IDelete
{
    DeleteOperationUnTenanted();
    DeleteOperationUnTenanted.fromJson(Map<String, dynamic> json) : super();
    fromMap(Map<String, dynamic> json) {
        return this;
    }

    Map<String, dynamic> toJson() => {};
    getTypeName() => "DeleteOperationUnTenanted<$TResponse>";
    TypeContext? context = _ctx;
}

enum AccountStatus
{
    Shadowed,
    Registered,
}

enum AccountType
{
    Person,
    Machine,
}

class UserAccount implements IIdentifiableResource, IConvertible
{
    List<String>? roles;
    AccountStatus? status;
    String? defaultOrganisationId;
    AccountType? type;
    String? id;

    UserAccount({this.roles,this.status,this.defaultOrganisationId,this.type,this.id});
    UserAccount.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        roles = JsonConverters.fromJson(json['roles'],'List<String>',context!);
        status = JsonConverters.fromJson(json['status'],'AccountStatus',context!);
        defaultOrganisationId = json['defaultOrganisationId'];
        type = JsonConverters.fromJson(json['type'],'AccountType',context!);
        id = json['id'];
        return this;
    }

    Map<String, dynamic> toJson() => {
        'roles': JsonConverters.toJson(roles,'List<String>',context!),
        'status': JsonConverters.toJson(status,'AccountStatus',context!),
        'defaultOrganisationId': defaultOrganisationId,
        'type': JsonConverters.toJson(type,'AccountType',context!),
        'id': id
    };

    getTypeName() => "UserAccount";
    TypeContext? context = _ctx;
}

class AssignUserRolesResponse implements IConvertible
{
    ResponseStatus? responseStatus;
    UserAccount? userAccount;

    AssignUserRolesResponse({this.responseStatus,this.userAccount});
    AssignUserRolesResponse.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        responseStatus = JsonConverters.fromJson(json['responseStatus'],'ResponseStatus',context!);
        userAccount = JsonConverters.fromJson(json['userAccount'],'UserAccount',context!);
        return this;
    }

    Map<String, dynamic> toJson() => {
        'responseStatus': JsonConverters.toJson(responseStatus,'ResponseStatus',context!),
        'userAccount': JsonConverters.toJson(userAccount,'UserAccount',context!)
    };

    getTypeName() => "AssignUserRolesResponse";
    TypeContext? context = _ctx;
}

class UnassignUserRolesRequest extends DeleteOperationUnTenanted<AssignUserRolesResponse> implements IConvertible
{
    String? id;
    List<String>? roles;

    UnassignUserRolesRequest({this.id,this.roles});
    UnassignUserRolesRequest.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        super.fromMap(json);
        id = json['id'];
        roles = JsonConverters.fromJson(json['roles'],'List<String>',context!);
        return this;
    }

    Map<String, dynamic> toJson() => super.toJson()..addAll({
        'id': id,
        'roles': JsonConverters.toJson(roles,'List<String>',context!)
    });

    getTypeName() => "UnassignUserRolesRequest";
    TypeContext? context = _ctx;
}

TypeContext _ctx = TypeContext(library: 'foundrystage_api_app.azurewebsites.net', types: <String, TypeInfo> {
    'DeleteOperationUnTenanted<TResponse>': TypeInfo(TypeOf.AbstractClass),
    'AccountStatus': TypeInfo(TypeOf.Enum, enumValues:AccountStatus.values),
    'AccountType': TypeInfo(TypeOf.Enum, enumValues:AccountType.values),
    'UserAccount': TypeInfo(TypeOf.Class, create:() => UserAccount()),
    'AssignUserRolesResponse': TypeInfo(TypeOf.Class, create:() => AssignUserRolesResponse()),
    'UnassignUserRolesRequest': TypeInfo(TypeOf.Class, create:() => UnassignUserRolesRequest()),
});

Dart UnassignUserRolesRequest 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

HTTP + JSON

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

DELETE /users/{Id}/roles/unassign HTTP/1.1 
Host: foundrystage-api-app.azurewebsites.net 
Accept: application/json
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":{"roles":["String"],"status":"Shadowed","defaultOrganisationId":"String","type":"Person","id":"String"}}