Foundry API

<back to all web services

UnassignUserRolesRequest

Requires Authentication
The following routes are available for this service:
DELETE/users/{Id}/roles/unassign
UnassignUserRolesRequest Parameters:
NameParameterData TypeRequiredDescription
IdpathstringNo
RolesqueryList<string>No
AssignUserRolesResponse Parameters:
NameParameterData TypeRequiredDescription
ResponseStatusformResponseStatusNo
UserAccountformUserAccountNo
UserAccount Parameters:
NameParameterData TypeRequiredDescription
RolesformList<string>No
StatusformAccountStatusNo
DefaultOrganisationIdformstringNo
TypeformAccountTypeNo
IdformstringNo
AccountStatus Enum:
Shadowed
Registered
AccountType Enum:
Person
Machine
AssignUserRolesResponse Parameters:
NameParameterData TypeRequiredDescription
ResponseStatusformResponseStatusNo
UserAccountformUserAccountNo

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

HTTP + JSV

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: text/jsv
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
		}
	},
	userAccount: 
	{
		roles: 
		[
			String
		],
		status: Shadowed,
		defaultOrganisationId: String,
		type: Person,
		id: String
	}
}