Versions Compared

Version Old Version 2 New Version 3
Changes made by

Magnus Frank

Magnus Frank

Saved on

Key

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

...

Panel
bgColor#DEEBFF

Icon legend

(tick) This parameter is required(thumbs down) This parameter is not recommended to use.

(warning) Deprecated

URL: /digizuitecore/loginservice/api/access-key

...

Name

Example

Description

username (tick)

lightuser

The username of the member to authenticate with. The field is case-insensitive

password(tick)

test

The password of the user to authenticate with. The field is case-sensitive.

The value can also be MD5 encoded if passwordEncoding is set to Md5.

passwordEncoding(tick)

Plaintext or Md5

How the passed password is encoded. Prefer Plaintext if possible. Md5 exists mainly for backward compatibility, and will be removed at some point in the future.

The password is always stored securely in the database, no matter the encoding passed here.

options

Code Block
{
    "configId": "/0/",
    "languageId": 3,
    "persistLanguage": false,
    "duration": "7.00:00:00"
  }

Additional options to customize the created access key. It can be left out entirely.

options.configId (thumbs down) (warning)

/0/

If you want to use a specific config id. This mainly required if you are working with Search2 that are not defined in the DAM product.

options.languageId

3

The id of the language to authorize with.

If not specified, the access key will be created in the default language for that user.

options.persistLanguage

true or false

If the users default language should be changed to the specified options.languageId going forward.

options.duration(thumbs down) (warning)

7.00:00:00 (7 days)

or 00:15:00 (15 minutes)

A C# TimeSpan formatted string to override how long this access key should be valid for. If not specified the access key will follow the system configured default.

In general it is not recommended to specify this, and instead integration should prefer to support automatic refreshing of access keys by looking at the expiration value in the response.

...