| POST | /organisations/{Id}/members |
|---|
export class PostOperationUnTenanted<TResponse> implements IPost
{
public constructor(init?: Partial<PostOperationUnTenanted<TResponse>>) { (Object as any).assign(this, init); }
}
export class Organisation implements IIdentifiableResource
{
public displayName?: string;
public owners?: string[];
public isDefault?: boolean;
public id?: string;
public forceTwoFactor: boolean;
public constructor(init?: Partial<Organisation>) { (Object as any).assign(this, init); }
}
export class InviteOrganisationMemberResponse
{
public responseStatus?: ResponseStatus;
public organisation?: Organisation;
public constructor(init?: Partial<InviteOrganisationMemberResponse>) { (Object as any).assign(this, init); }
}
export class InviteOrganisationMemberRequest extends PostOperationUnTenanted<InviteOrganisationMemberResponse>
{
public id?: string;
public userId?: string;
public userEmailAddress?: string;
public role?: string;
public constructor(init?: Partial<InviteOrganisationMemberRequest>) { super(init); (Object as any).assign(this, init); }
}
TypeScript InviteOrganisationMemberRequest DTOs
To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
POST /organisations/{Id}/members HTTP/1.1
Host: staging-api.foundrylab.com
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length
{
id: String,
userId: String,
userEmailAddress: String,
role: String
}
HTTP/1.1 200 OK
Content-Type: text/jsv
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
}
}