Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Note

Do not add tasks manually in the Assert folder in the Task Scheduler, they will be erased by the Manager.

Calling Api using authentication

Info

This function is available in version 5.3 and later.

When tasks are run on the server, the task implementation in PowerShell scripts call remote server Api functions. The Api is protected by authentication, Basic or by an Api-key. Scripts are programmed to lookup username and password in a configuration file. Without the file, import and publish jobs will be denied and will fail. Currently we use the entries with Role = PublisherApi for publish and import tasks, and BulletinMail for a task to send batch mails.

Info

If an Api-key is defined, the Api-call will be made use it for authentication. If not, a Basic authentication call is made using the username and the password.

Info

For publish and import, the username and password, or the ApiKey must correspond to the definition in the api-permission.config file. Or in the profile for bulletin mails.

Configuration file name:

Code Block
C:\ProgramData\Signifikant\Assert\api-permission-client.config

Example of content:

Code Block
<?xml version="1.0" encoding="utf-8"?>
<ApiPermissionClient xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
	<Enabled>true</Enabled>
	<ClientList>
		<Client>
			<Enabled>true</Enabled>
			<Role>PublisherApi</Role>
			<Username>admin</Username>
			<Password>admin</Password>
			<ApiKey>zaCELgL.0imfnc8mVLWwsAawjYr4Rx-Af50DDqtlx</ApiKey>
		</Client>
		<Client>
			<Enabled>true</Enabled>
			<Role>BulletinMail</Role>
			<Username>bulletin</Username>
			<Password>bulletin</Password>
		</Client>
	</ClientList>
</ApiPermissionClient>

Filter by label (Content by label)
showLabelsfalse
max5
spacescom.atlassian.confluence.content.render.xhtml.model.resource.identifiers.SpaceResourceIdentifier@1ecd09
showSpacefalse
sortmodified
typepage
reversetrue
labelsimport publish task automation automatic scheduled clean
cqllabel in ( "scheduled" , "automation" , "clean" , "task" , "publish" , "import" , "automatic" ) and type = "page" and space = "ASKB"

...