Foundry API

<back to all web services

UnassignUserRolesRequest

Requires Authentication
The following routes are available for this service:
DELETE/users/{Id}/roles/unassign
import datetime
import decimal
from marshmallow.fields import *
from servicestack import *
from typing import *
from dataclasses import dataclass, field
from dataclasses_json import dataclass_json, LetterCase, Undefined, config
from enum import Enum, IntEnum


TResponse = TypeVar('TResponse')


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class DeleteOperationUnTenanted(Generic[TResponse], IReturn[TResponse], IDelete):
    @staticmethod
    def response_type(): return TResponse


class AccountStatus(str, Enum):
    SHADOWED = 'Shadowed'
    REGISTERED = 'Registered'


class AccountType(str, Enum):
    PERSON = 'Person'
    MACHINE = 'Machine'


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class UserAccount(IIdentifiableResource):
    roles: Optional[List[str]] = None
    status: Optional[AccountStatus] = None
    default_organisation_id: Optional[str] = None
    type: Optional[AccountType] = None
    id: Optional[str] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class AssignUserRolesResponse:
    response_status: Optional[ResponseStatus] = None
    user_account: Optional[UserAccount] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class UnassignUserRolesRequest(DeleteOperationUnTenanted[AssignUserRolesResponse]):
    id: Optional[str] = None
    roles: Optional[List[str]] = None

Python 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"}}