Edit system keystone authentication settings

Edit online

Configure the Keystone authentication settings for the system. An external Keystone server can be used to authenticate users. When configured, you can create accounts or groups in the system and tie them to users, groups, and projects in the external Keystone server. Keystone users can then authenticate against Accesser devices by using their Keystone credentials.

Request

Edit online

Security

Edit online
Table 1. Roles capable of executing the Edit System Keystone Authentication Settings API method
Any Super User System Admin Security Admin Operator
  superUser systemAdmin    

HTTP method

Edit online

POST /manager/api/{apiResponseType}/1.0/systemHttpConfiguration.adm HTTP/1.1 Host:{manager.dsnet} enabled={true|false}&hostname={hostname}&version={v2|v3}&usingCustomPort={true|false}&port={port}&secure={true|false}&adminToken={adminToken}&domainSeparator={v3DomainSeparator}&usingDefaultDomain={true|false}&domain={defaultDomain}&certificatePem={certificatesInPEMFormat}

Curl method

Edit online

curl -u {admin}:{password} -k ”https://{manager.dsnet}/manager/api/{apiResponseType}/1.0/systemHttpConfiguration.adm“ -d ”enabled={true|false}&hostname={hostname}&version={v2|v3}&usingCustomPort={true|false}&port={port}&secure={true|false}&adminToken={adminToken}&domainSeparator={v3DomainSeparator}&usingDefaultDomain={true|false}&domain={defaultDomain}&certificatePem={certificatesInPEMFormat}“

Parameters

Edit online
Table 2. Request parameters for Edit System Keystone Authentication Settings (systemHttpConfiguration) API method
Parameter Type Usage Default Description
enabled Boolean Optional false

Enable or disable keystone authentication with the system.
hostname String enabled=true  

The host name of the keystone server, not including the protocol.
version String Optional v3

The protocol version of the keystone server:

  • v3 (Keystone v3)
  • v2 (Keystone v2.0)
usingCustomPort Boolean    

Flag representing whether the Keystone server uses a non-default port or not. The default admin port for Keystone is 35357.
port Integer usingCustomPort=true  

The port that is used by the Keystone server.
secure Boolean Optional  

Flag representing whether the Keystone server uses HTTPS or not.
adminToken String enabled=true  

A shared secret with the keystone configuration that is used to validate tokens and group/project membership.
domainSeparator String version=v3  

A character that is used to separate keystone user names from domains. It must be a character that is not used in any keystone user name.
usingDefaultDomain Boolean Optional  

Flag representing whether a default domain is set. By default, authenticating with a keystone server requires both the user name and domain. When a default domain is configured, Keystone users can authenticate without specifying a domain, and the default domain is applied implicitly.
domain String usingDefaultDomain=true  

The name of a keystone domain that is used to scope all authenticated keystone requests that do not explicitly specify a domain.
certificatePem String Optional  

The certificate, or certificates, in PEM format. The certificate must be self-signed.