DigiOffice Gateway Web Services

<back to all web services

AssignRoles

auth
Requires Authentication
Required role:Admin
The following routes are available for this service:
POST/api/assignroles
AssignRoles Parameters:
NameParameterData TypeRequiredDescription
UserNamebodystringNo
PermissionsbodyList<string>No
RolesbodyList<string>No
MetabodyDictionary<string, string>No
AssignRolesResponse Parameters:
NameParameterData TypeRequiredDescription
AllRolesformList<string>No
AllPermissionsformList<string>No
MetaformDictionary<string, string>No
ResponseStatusformResponseStatusNo

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 /api/assignroles HTTP/1.1 
Host: digiofficeapigateway.deltares.nl 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	UserName: String,
	Permissions: 
	[
		String
	],
	Roles: 
	[
		String
	],
	Meta: 
	{
		String: String
	}
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	AllRoles: 
	[
		String
	],
	AllPermissions: 
	[
		String
	],
	Meta: 
	{
		String: String
	},
	ResponseStatus: 
	{
		ErrorCode: String,
		Message: String,
		StackTrace: String,
		Errors: 
		[
			{
				ErrorCode: String,
				FieldName: String,
				Message: String,
				Meta: 
				{
					String: String
				}
			}
		],
		Meta: 
		{
			String: String
		}
	}
}