Outdated documentation

You are looking at the documentation for an older release. For the latest information, please see current release documentation.

Credentials

Use this screen to manage credentials in the system. The credential management screen is available in the Credentials module of the Communication & Notifications group.

Credential Management Screen

Manage Credentials

To add a new credential:

1. Choose a method in the left sidebar and select a type from its drop-down.
2. Fill in the required fields.
3. Click on the Save button.

Add BasicAuth Credential Screen

To edit a credential:

1. Click on a credential in the list of credentials.
2. Modify the fields.
3. Click on the Save or Save and finish button.

Edit BasicAuth Credential Screen

To delete a credential:

1. Click on the trash icon in the second last column of the overview table.
2. Click on the Confirm button.

Delete Credential Screen

Note

If several credentials are added to the system, use the filter box to find a particular credential by just typing the name to filter.

Note

If the emails cannot be fetched and yes is displayed in the Update Needed column, click the shield icon to authorize the credentials manually. If this happens regularly, please contact the Customer Solutions Team for further analysis.

Credential Settings

The following settings are available when adding or editing this resource. The fields marked with an asterisk are mandatory.

General Credential Settings

These settings are the same for all types of credentials.

Credential General Screen

Name *

The name of this resource. Must be unique and only accept alphabetic and numeric characters. The name will be displayed in the overview table.

Validity

Set the validity of this resource. Each resource can be used in OTRS only, if this field is set to valid. Setting this field to invalid or invalid-temporarily will disable the use of the resource.

Type

This type have been selected in the previous page and can not be changed here anymore. This is a read-only field.

BasicAuth Credential Settings

The following settings are available if BasicAuth was selected in the credential management screen. The fields marked with an asterisk are mandatory.

BasicAuth Credential Settings Screen

Username *

The username for the credential.

Password *

The password for the credential.

Certificate Credential Settings

The following settings are available if Certificate was selected in the credential management screen. The fields marked with an asterisk are mandatory.

Certificate Credential Settings Screen

Certificate *

The certificate itself as a string. A certificate should look like this:

-----BEGIN CERTIFICATE-----
bjJ4b05tdXZkZnZ1ZUF5S0lwZlJUTUlYY0dGa0l4OFpHc0xPbU93UkhZTG5Pc3BE
NDJEUUM0NFpJZFRrUFdubGJ6UUJiYmNtdnh3ZVRiSG0zUVhwVXVVdXpXZzRaREN0
...
ZW9NeWpsRXo2Z1VLTk9pT0RoVmJOVE5TbTFGTFA2TXRScW16dWxvUWloWERWaTQy
UVNTdkhQN0lHVjNJT2JTWnpWRWxqc1ZHMFVjSWxXOGNxUW9ySHhwVm5lbQo=
-----END CERTIFICATE-----

Certificate Key

The private key of the certificate. A private key should look like this:

-----BEGIN RSA PRIVATE KEY-----
MFZFUnBqbUhYd2pIZFNEZ29oV0lBdTBGek84UkRaQWxQeVR1azE5OXJEVG45OWUz
b25GeWRsNzlBV1BHTjFzOWs2NVFLdHFTSDRYWnFjc3oxS09Rd3Y2NFc1ZkRFNGhp
...
TUZaRlVuQnFiVWhZZDJwSVpGTkVaMjlvVjBsQmRUQkdlazg0VWtSYVFXeFFlVlIx
T1dVemIyNUdlV1JzTnpsQlYxQkhUakZ6T1dzMk5WRkxkSEZUU0RSWQo=
-----END RSA PRIVATE KEY-----

Certificate Key Password

If the certificate key has a password, you can enter it here.

MicrosoftGraphApp Credential Settings

The following settings are available if MicrosoftGraphApp was selected in the credential management screen. The fields marked with an asterisk are mandatory.

MicrosoftGraphApp Credential Settings Screen

Tenant *

The tenant for the application.

Client ID *

The client ID for the application.

Client Secret *

The client secret for the application.

Scope *

The scope for the application.