( Return to API Overview )
- create
- delete
- getDetails
- listAllKeys
- update
Description
Provides methods to manipulate kickstart keys.
Namespace:
kickstart.keys
Description:
creates a new key with the given parameters
Parameters:
-
string session_key
-
string description
-
string type - valid values are GPG or SSL
-
string content
Returns:
-
int - 1 on success, exception thrown otherwise.
Description:
deletes the key identified by the given parameters
Parameters:
-
string session_key
-
string description
Returns:
-
int - 1 on success, exception thrown otherwise.
Description:
returns all of the data associated with the given key
Parameters:
-
string session_key
-
string description
Returns:
-
struct - key
- string "description"
- string "type"
- string "content"
Description:
list all keys for the org associated with the user logged into the
given session
Parameters:
Returns:
-
array:
-
struct - key
- string "description"
- string "type"
Description:
Updates type and content of the key identified by the description
Parameters:
-
string session_key
-
string description
-
string type - valid values are GPG or SSL
-
string content
Returns:
-
int - 1 on success, exception thrown otherwise.
Generated on 3/4/2020