Foundry API

<back to all web services

AssignUserRolesRequest

Requires Authentication
The following routes are available for this service:
POST/users/{Id}/roles/assign
import java.math.*;
import java.util.*;
import net.servicestack.client.*;

public class dtos
{

    public static class AssignUserRolesRequest extends PostOperationUnTenanted<AssignUserRolesResponse>
    {
        public String id = null;
        public ArrayList<String> roles = null;
        
        public String getId() { return id; }
        public AssignUserRolesRequest setId(String value) { this.id = value; return this; }
        public ArrayList<String> getRoles() { return roles; }
        public AssignUserRolesRequest setRoles(ArrayList<String> value) { this.roles = value; return this; }
    }

    public static class PostOperationUnTenanted<TResponse> implements IPost
    {
        
    }

    public static class AssignUserRolesResponse
    {
        public ResponseStatus responseStatus = null;
        public UserAccount userAccount = null;
        
        public ResponseStatus getResponseStatus() { return responseStatus; }
        public AssignUserRolesResponse setResponseStatus(ResponseStatus value) { this.responseStatus = value; return this; }
        public UserAccount getUserAccount() { return userAccount; }
        public AssignUserRolesResponse setUserAccount(UserAccount value) { this.userAccount = value; return this; }
    }

    public static class UserAccount implements IIdentifiableResource
    {
        public ArrayList<String> roles = null;
        public AccountStatus status = null;
        public String defaultOrganisationId = null;
        public AccountType type = null;
        public String id = null;
        
        public ArrayList<String> getRoles() { return roles; }
        public UserAccount setRoles(ArrayList<String> value) { this.roles = value; return this; }
        public AccountStatus getStatus() { return status; }
        public UserAccount setStatus(AccountStatus value) { this.status = value; return this; }
        public String getDefaultOrganisationId() { return defaultOrganisationId; }
        public UserAccount setDefaultOrganisationId(String value) { this.defaultOrganisationId = value; return this; }
        public AccountType getType() { return type; }
        public UserAccount setType(AccountType value) { this.type = value; return this; }
        public String getId() { return id; }
        public UserAccount setId(String value) { this.id = value; return this; }
    }

    public static enum AccountStatus
    {
        Shadowed,
        Registered;
    }

    public static enum AccountType
    {
        Person,
        Machine;
    }

}

Java AssignUserRolesRequest DTOs

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.

POST /users/{Id}/roles/assign HTTP/1.1 
Host: foundrystage-api-app.azurewebsites.net 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

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