Foundry API

<back to all web services

AssignOrganisationRolesRequest

Requires Authentication
The following routes are available for this service:
POST/organisations/{Id}/roles/assign
import 'package:servicestack/servicestack.dart';

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

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

class Organisation implements IIdentifiableResource, IConvertible
{
    String? displayName;
    List<String>? owners;
    bool? isDefault;
    String? id;
    bool? forceTwoFactor;

    Organisation({this.displayName,this.owners,this.isDefault,this.id,this.forceTwoFactor});
    Organisation.fromJson(Map<String, dynamic> json) { fromMap(json); }

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

    Map<String, dynamic> toJson() => {
        'displayName': displayName,
        'owners': JsonConverters.toJson(owners,'List<String>',context!),
        'isDefault': isDefault,
        'id': id,
        'forceTwoFactor': forceTwoFactor
    };

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

class AssignOrganisationRolesResponse implements IConvertible
{
    ResponseStatus? responseStatus;
    Organisation? organisation;

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

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

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

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

class AssignOrganisationRolesRequest extends PostOperationUnTenanted<AssignOrganisationRolesResponse> implements IConvertible
{
    String? id;
    String? userId;
    List<String>? roles;

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

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

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

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

TypeContext _ctx = TypeContext(library: 'foundrystage_api_app.azurewebsites.net', types: <String, TypeInfo> {
    'PostOperationUnTenanted<TResponse>': TypeInfo(TypeOf.AbstractClass),
    'Organisation': TypeInfo(TypeOf.Class, create:() => Organisation()),
    'AssignOrganisationRolesResponse': TypeInfo(TypeOf.Class, create:() => AssignOrganisationRolesResponse()),
    'AssignOrganisationRolesRequest': TypeInfo(TypeOf.Class, create:() => AssignOrganisationRolesRequest()),
});

Dart AssignOrganisationRolesRequest 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 /organisations/{Id}/roles/assign HTTP/1.1 
Host: foundrystage-api-app.azurewebsites.net 
Accept: text/csv
Content-Type: text/csv
Content-Length: length

{"id":"String","userId":"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"}},"organisation":{"displayName":"String","owners":["String"],"isDefault":false,"id":"String","forceTwoFactor":false}}