CloudCredentialsController Resource

This controller is responsible for handling CloudCredentials. CloudCredentials are a represntation of the credentials that are used by the provisoner to request for resources (VMs)

POST /user/v1.0/credentials/cloud

Post the cloud credentials.

Security Roles Allowed
ADMIN, USER
Request Body
media type data type
application/json CloudCredentials (JSON)
application/xml cloudCredentials (XML)
Response Codes
code condition
400 Key or KeyIdAlias can't be empty
Response Body
media type data type description
application/json string (JSON) the CloudCredentials id
application/xml string (XML)

Example

Request
POST /user/v1.0/credentials/cloud
Content-Type: application/json
Accept: application/json

                
{
  "id" : "...",
  "key" : "6J7uo99ifrff45126Gsy5vgb3bmrtwY6hBxtYt9y",
  "keyIdAlias" : "AKIAITY3K5ZUQ6M7YBSQ",
  "loginKeys" : [ {
    "name" : "id_dsa.pub",
    "id" : "...",
    "type" : "PRIVATE",
    "attributes" : {
      "property1" : "domain_name:Virginia",
      "property2" : "domain_name:Virginia"
    },
    "key" : "-----BEGIN RSA PRIVATE KEY-----\\nMIIEogIBAAKCAQEAm6AALYxkJFNzD3bfVJ4+hMY5j0/kqM9CURLKXMlYuAysnvoG8wZKx9Bedefm\\neNSse4zTg798ZA2kDMZFIrwp1AseTwtj8DDu5fhG5DjyI3g6iJltS5zFQdMXneDlHXBX8cncSzNY\\nRx0NdjEMAe7YttvI8FNlxL0VnMFli/HB/ftzYMe5+AmkSROncVGHiwoiUpj+vtobCFOYtXsCf6ri\\nd4lgWA5wv6DZT/JKCYymiBqgSXu3ueFcEzw5SAukARWVjn1xccjZkokFfBbO/FpYY00TrUTBw9S6\\nD3iM+gj8RT6EKILOmhrt71D21S95WAWIT7h2YBsy1KAvMixhNf9VaQIDAQABAoIBAHhVYK3Xl3tr\\nN1Xm0ctJTQg3ijxhR2qsUBgGUokqezpdOoD2zbbOz7XvTYsX1GLr967U9pwxzUpELexexwiTvDgk\\nnLv8D7ui6qbRsmc4DSsWBRSophVIVFKQmftO8Xow6x+fuYJAYmsicM1KIYHBILtL+PSzV8anenWq\\nKQ3r0tfCiQhEzKEk4b1uT3SJWQyHE++JAhVkO7lIeb6S9Dg1jAaAeMnJ/NiMxTarpPRnxe6hsTsH\\ngG1iKWo+Skcl4SknOc+CMEfyDjG4FL7MGhKduahsO8vMUrgGsDD7EH3NiX/FweB8La6qpDYAwFpC\\nycrooyhiyzw8Wb5gGaYnmvr9l70CgYEAx74O8JleXaHpxEAmh4h7VbLmJ3mOylfBmOdzcHeedJQw\\nack2SAv65WBI9S9MEQ7J/vFuyw5HNk3C/mcWgzDQXSNIhHLvl/Z9sux/Qpm3SQWLzBxKV3dJ4r\\nwcAxzVA93+/L1Nee+VOKnlyRumvVa6+XLsLagpap2AVcTqlerMcCgYEAx3T2pXtqkCE9eU/ov22r\\npdaKjgHoGOUg1CMEfWi/Ch6sYIIRyrHz6dhy+yR1pXNgPbLWdrn8l88F3+IsmbaMupMgRmqwEC3G\\n9Y2FglGIVvRdZaagvRxLzRCcvcN4v6OYs9ST4o1xlv7Qxphld+0XDKv7VSCv/rASuK8BqlFL3E8C\\ngYArMXJRnRjG7qh6g9TRIjZphdI3XxX9s5Rt2D8iZvuhAhqmBZjzY4PR7kxYmO2+EpCjzNnEl0XW\\n/GHaWbiIjhnAykx4N9KP7gGom3O5lzwHUme1XnFKcO2wDjQwJbufRmba8iQF1srN577mF+Z7ha4V\\nJ1duCTzvWF1KFX6sk/uhKQKBgAcDFai7rgNjJ8YcCRKxyFcMM9LKPl6hr4XFtWKzTAQPEABUkkuN\\n9gVClsg9f+VRKRECOIf0Ae1UWeCFEwxUXp4wjfHrzkTDVztKvmbWdvSXorDwKrZ7SC7tZpVFSfly\\nxuuLjadpUZT9YFmbAfY1X5oSccOMYqORjRbxEB3svb4BAoGAGTgFuq9Zojh/KIqY8b4HpEfmh6CQ\\nhLVfD98Nqd6GDbxgvIM0v4mFXE92x2jn35Ia0JdFyh3B8Vkl7sqQZfxDFXI9O9pte2mxY9ICaY\\n55+X/SN1pd53BH+gaPZJy/R+Vpvs5MN48hoUKy5UKpoFeUWrS5QArjtvNCm4SGlXw=\\n-----END RSA PRIVATE KEY-----\\n",
    "owner" : "..."
  }, {
    "name" : "...",
    "id" : "...",
    "type" : "PUBLIC",
    "attributes" : {
      "property1" : "...",
      "property2" : "..."
    },
    "key" : "...",
    "owner" : "..."
  } ],
  "cloudProviderName" : "ec2",
  "keypass" : "123passwd",
  "owner" : "..."
}
Response
HTTP/1.1 201 Looks Good
Content-Type: application/json

                
...

DELETE /user/v1.0/credentials/cloud/all

Security Roles Allowed
ADMIN
Response Body
media type data type
application/json string (JSON)
application/xml string (XML)

Example

Request
DELETE /user/v1.0/credentials/cloud/all
Accept: application/json
Response
HTTP/1.1 204 Looks Good
Content-Type: application/json

                
...

GET /user/v1.0/credentials/cloud/ids

Gets all the IDs of the stored cloud credentials

Security Roles Allowed
ADMIN, USER
Response Body
media type data type description
application/json array of string (JSON) a list of stored IDs
application/xml list of string (XML)

Example

Request
GET /user/v1.0/credentials/cloud/ids
Accept: application/json
Response
HTTP/1.1 200 Looks Good
Content-Type: application/json

                
...

DELETE /user/v1.0/credentials/cloud/{id}

Delete the cloud credentials

Security Roles Allowed
ADMIN, USER
Request Parameters
name type description
id path the id of the cloud credentials
Response Body
media type data type description
application/json string (JSON) the id of the cloud credentials
application/xml string (XML)

Example

Request
DELETE /user/v1.0/credentials/cloud/{id}
Accept: application/json
Response
HTTP/1.1 204 Looks Good
Content-Type: application/json

                
...

GET /user/v1.0/credentials/cloud/{id}

Get the cloud credentials

Security Roles Allowed
ADMIN, USER
Request Parameters
name type description
id path the id of the cloud credentials
Response Body
media type data type description
application/json CloudCredentials (JSON) the cloud credentials
application/xml cloudCredentials (XML)

Example

Request
GET /user/v1.0/credentials/cloud/{id}
Accept: application/json
Response
HTTP/1.1 200 Looks Good
Content-Type: application/json

                
{
  "id" : "...",
  "key" : "6J7uo99ifrff45126Gsy5vgb3bmrtwY6hBxtYt9y",
  "keyIdAlias" : "AKIAITY3K5ZUQ6M7YBSQ",
  "loginKeys" : [ {
    "name" : "id_dsa.pub",
    "id" : "...",
    "type" : "PRIVATE",
    "attributes" : {
      "property1" : "domain_name:Virginia",
      "property2" : "domain_name:Virginia"
    },
    "key" : "-----BEGIN RSA PRIVATE KEY-----\\nMIIEogIBAAKCAQEAm6AALYxkJFNzD3bfVJ4+hMY5j0/kqM9CURLKXMlYuAysnvoG8wZKx9Bedefm\\neNSse4zTg798ZA2kDMZFIrwp1AseTwtj8DDu5fhG5DjyI3g6iJltS5zFQdMXneDlHXBX8cncSzNY\\nRx0NdjEMAe7YttvI8FNlxL0VnMFli/HB/ftzYMe5+AmkSROncVGHiwoiUpj+vtobCFOYtXsCf6ri\\nd4lgWA5wv6DZT/JKCYymiBqgSXu3ueFcEzw5SAukARWVjn1xccjZkokFfBbO/FpYY00TrUTBw9S6\\nD3iM+gj8RT6EKILOmhrt71D21S95WAWIT7h2YBsy1KAvMixhNf9VaQIDAQABAoIBAHhVYK3Xl3tr\\nN1Xm0ctJTQg3ijxhR2qsUBgGUokqezpdOoD2zbbOz7XvTYsX1GLr967U9pwxzUpELexexwiTvDgk\\nnLv8D7ui6qbRsmc4DSsWBRSophVIVFKQmftO8Xow6x+fuYJAYmsicM1KIYHBILtL+PSzV8anenWq\\nKQ3r0tfCiQhEzKEk4b1uT3SJWQyHE++JAhVkO7lIeb6S9Dg1jAaAeMnJ/NiMxTarpPRnxe6hsTsH\\ngG1iKWo+Skcl4SknOc+CMEfyDjG4FL7MGhKduahsO8vMUrgGsDD7EH3NiX/FweB8La6qpDYAwFpC\\nycrooyhiyzw8Wb5gGaYnmvr9l70CgYEAx74O8JleXaHpxEAmh4h7VbLmJ3mOylfBmOdzcHeedJQw\\nack2SAv65WBI9S9MEQ7J/vFuyw5HNk3C/mcWgzDQXSNIhHLvl/Z9sux/Qpm3SQWLzBxKV3dJ4r\\nwcAxzVA93+/L1Nee+VOKnlyRumvVa6+XLsLagpap2AVcTqlerMcCgYEAx3T2pXtqkCE9eU/ov22r\\npdaKjgHoGOUg1CMEfWi/Ch6sYIIRyrHz6dhy+yR1pXNgPbLWdrn8l88F3+IsmbaMupMgRmqwEC3G\\n9Y2FglGIVvRdZaagvRxLzRCcvcN4v6OYs9ST4o1xlv7Qxphld+0XDKv7VSCv/rASuK8BqlFL3E8C\\ngYArMXJRnRjG7qh6g9TRIjZphdI3XxX9s5Rt2D8iZvuhAhqmBZjzY4PR7kxYmO2+EpCjzNnEl0XW\\n/GHaWbiIjhnAykx4N9KP7gGom3O5lzwHUme1XnFKcO2wDjQwJbufRmba8iQF1srN577mF+Z7ha4V\\nJ1duCTzvWF1KFX6sk/uhKQKBgAcDFai7rgNjJ8YcCRKxyFcMM9LKPl6hr4XFtWKzTAQPEABUkkuN\\n9gVClsg9f+VRKRECOIf0Ae1UWeCFEwxUXp4wjfHrzkTDVztKvmbWdvSXorDwKrZ7SC7tZpVFSfly\\nxuuLjadpUZT9YFmbAfY1X5oSccOMYqORjRbxEB3svb4BAoGAGTgFuq9Zojh/KIqY8b4HpEfmh6CQ\\nhLVfD98Nqd6GDbxgvIM0v4mFXE92x2jn35Ia0JdFyh3B8Vkl7sqQZfxDFXI9O9pte2mxY9ICaY\\n55+X/SN1pd53BH+gaPZJy/R+Vpvs5MN48hoUKy5UKpoFeUWrS5QArjtvNCm4SGlXw=\\n-----END RSA PRIVATE KEY-----\\n",
    "owner" : "..."
  }, {
    "name" : "...",
    "id" : "...",
    "type" : "PRIVATE",
    "attributes" : {
      "property1" : "...",
      "property2" : "..."
    },
    "key" : "...",
    "owner" : "..."
  } ],
  "cloudProviderName" : "ec2",
  "keypass" : "123passwd",
  "owner" : "..."
}

POST /user/v1.0/credentials/cloud/upload/{id}

Upload the login keys for a cloud provider. The cloud credentials have to be created

Security Roles Allowed
ADMIN, USER
Request Parameters
name type description
id path  
file query  
Response Body
media type data type description
application/json string (JSON) the CloudCredentials id
application/xml string (XML)

Example

Request
POST /user/v1.0/credentials/cloud/upload/{id}
Accept: application/json
Response
HTTP/1.1 201 Looks Good
Content-Type: application/json

                
...