SSHKey

None

Overview

description string filterable   orderable  
entityScope enum (ENTERPRISE | GLOBAL) autogenerated  
externalID string filterable   orderable   locally unique  
keyType enum (RSA) filterable   orderable  
lastUpdatedBy string autogenerated  
name string required   filterable   orderable  
publicKey string

API Resource

/sshkeys/id
delete get put

Parents

/infrastructureaccessprofiles/id/sshkeys
get post

Children

/sshkeys/id/metadatas
get post
/sshkeys/id/globalmetadatas
get post put

Members

This object has no members.

Attributes documentation

description string filterable   orderable  
Discussion

A description of the SSH Key.

Charateristics

Format: free
Max length: 255
SDK attribute: description

entityScope enum autogenerated  
Discussion

Specify if scope of entity is Data center or Enterprise level

Charateristics

Allowed values: ENTERPRISE, GLOBAL
SDK attribute: entityScope

externalID string filterable   orderable   locally unique  
Discussion

External object ID. Used for integration with third party systems

Charateristics

Format: free
SDK attribute: externalID

keyType enum filterable   orderable  
Discussion

Type of SSH Key defined. Only RSA supported for now.

Charateristics

Allowed values: RSA
Default value: RSA
SDK attribute: keyType

lastUpdatedBy string autogenerated  
Discussion

ID of the user who last updated the object.

Charateristics

Format: free
SDK attribute: lastUpdatedBy

name string required   filterable   orderable  
Discussion

Name of the SSH Key.

Charateristics

Format: free
Min length: 1
Max length: 255
SDK attribute: name

publicKey string
Discussion

Public Key of a SSH Key Pair.

Charateristics

Format: free
Max length: 4096
SDK attribute: publicKey