kickstart.keys

Description

Provides methods to manipulate kickstart keys.

Namespace:

kickstart.keys

Method: create

HTTP POST

Description:

creates a new key with the given parameters

Parameters:

  • string sessionKey

  • string description

  • string type - valid values are GPG or SSL

  • string content

Returns:

  • int - 1 on success, exception thrown otherwise.

Method: delete

HTTP POST

Description:

deletes the key identified by the given parameters

Parameters:

  • string sessionKey

  • string description

Returns:

  • int - 1 on success, exception thrown otherwise.

Method: getDetails

HTTP GET

Description:

returns all the data associated with the given key

Parameters:

  • string sessionKey

  • string description

Returns:

  • struct key

    • string "description"

    • string "type"

    • string "content"

Method: listAllKeys

HTTP GET

Description:

list all keys for the org associated with the user logged into the given session

Parameters:

  • string sessionKey

Returns:

  • array :

    • struct key

      • string "description"

      • string "type"

Method: update

HTTP POST

Description:

Updates type and content of the key identified by the description

Parameters:

  • string sessionKey

  • string description

  • string type - valid values are GPG or SSL

  • string content

Returns:

  • int - 1 on success, exception thrown otherwise.