Jump to

• Request
• Response
• Examples

View Summaries for Selected SSH Keys

get

/paas/api/v1.1/instancemgmt/{identityDomainId}/services/dbaas/credentials/crednames

Returns summary information about SSH keys for Exadata Cloud at Customer as determined by query parameters you provide.

By default, a single request returns a maximum of 50 keys. Use the limitRowCount query parameter to control maximum number returned, and use the offset query parameter to fetch additional results, if available.

Request

Path Parameters

• identityDomainId: string

  The value depends on the type of Exadata Cloud at Customer account that is used to make the request:

  • For a Traditional Cloud Account, specify the Identity Domain Name that is associated with the service.

  • For a Cloud Account with Identity Cloud Service, specify the Identity Service Id that is associated with the service, which is a character string beginning with idcs-.

Query Parameters

• limitRowCount(optional): string
  The maximum number of keys to include in the response. If omitted, a maximum of 50 keys are included in the response.
• offset(optional): string
  The number of keys to skip before starting to collect keys for the response. If omitted, zero keys are skipped so that the response begins with the first key.
• serviceName(optional): string
  Name of an Exadata Cloud at Customer database deployment. Provide the name of an Exadata Cloud at Customer database deployment to limit output to keys associated with the corresponding Exadata Cloud at Customer environment. If you do not supply a deployment name, the output will show all of the SSH keys associated with all database deployments in the specified identity domain.

Header Parameters

• Authorization: string
  Base64 encoding of the user name and password of the user making the request. For more information, see Security, Authentication and Authorization.
• X-ID-TENANT-NAME: string

  The value depends on the type of Exadata Cloud at Customer account that is used to make the request:

  • For a Traditional Cloud Account, specify the Identity Domain Name that is associated with the service.

  • For a Cloud Account with Identity Cloud Service, specify the Identity Service Id that is associated with the service, which is a character string beginning with idcs-.

  For more information, see Security, Authentication and Authorization.

Back to Top

Response

Supported Media Types

• application/json

200 Response

OK. See Status Codes for information about other possible HTTP status codes.

Body ()

Root Schema : Response Body

Type: object

Title: Response Body

Show Source

• hasMore(optional): boolean
  Indicates whether more keys are available to be requested, with the value true indicating that more are available.
• items(optional): array items Array
  Title: items Array

  Array of JSON objects, with one element for each key returned.
• totalResults(optional): integer
  Number of keys returned by this request.

{
    "title":"Response Body",
    "type":"object",
    "description":"",
    "properties":{
        "hasMore":{
            "type":"boolean",
            "description":"Indicates whether more keys are available to be requested, with the value <code>true</code> indicating that more are available."
        },
        "items":{
            "title":"items Array",
            "type":"array",
            "description":"Array of JSON objects, with one element for each key returned.",
            "items":{
                "$ref":"#/definitions/view-summaries-selected-items-array-item"
            }
        },
        "totalResults":{
            "type":"integer",
            "description":"Number of keys returned by this request."
        }
    }
}

Nested Schema : items Array

Type: array

Title: items Array

Array of JSON objects, with one element for each key returned.

Show Source

• Array of: object items Array Item
  Title: items Array Item

{
    "title":"items Array",
    "type":"array",
    "description":"Array of JSON objects, with one element for each key returned.",
    "items":{
        "$ref":"#/definitions/view-summaries-selected-items-array-item"
    }
}

Nested Schema : items Array Item

Type: object

Title: items Array Item

Show Source

• canonicalUrl(optional): string
  URL to query the credential key value.
• credName(optional): string
  The value vmspublickey.
• credType(optional): string
  The value SSH.
• description(optional): string
  A description of the key.
• identityDomain(optional): string
  Name of the identity domain.
• serviceName(optional): string
  Name of the Exadata Cloud at Customer database deployment.
• serviceType(optional): string
  The value DBaaS.

{
    "title":"items Array Item",
    "type":"object",
    "properties":{
        "canonicalUrl":{
            "type":"string",
            "description":"URL to query the credential key value."
        },
        "credName":{
            "type":"string",
            "description":"The value <code>vmspublickey</code>."
        },
        "credType":{
            "type":"string",
            "description":"The value <code>SSH</code>."
        },
        "description":{
            "type":"string",
            "description":"A description of the key."
        },
        "identityDomain":{
            "type":"string",
            "description":"Name of the identity domain."
        },
        "serviceName":{
            "type":"string",
            "description":"Name of the Exadata Cloud at Customer database deployment."
        },
        "serviceType":{
            "type":"string",
            "description":"The value <code>DBaaS</code>."
        }
    }
}

Back to Top

Examples

The following example shows how to view summary information about SSH keys associated with Exadata Cloud at Customer by submitting a GET request on the REST endpoint using cURL.

In this example, the identity domain is usexample, and the Oracle Cloud user name and password are serviceadmin and Pa55_word.

cURL Command

curl -i -X GET --cacert ~/cacert.pem -u serviceadmin:Pa55_word -H "X-ID-TENANT-NAME:usexample"  https://dbaas.oraclecloud.com/paas/api/v1.1/instancemgmt/usexample/services/dbaas/credentials/crednames

HTTP Status Code and Response Headers

HTTP/2.0 200
server: Oracle-Application-Server-11g
strict-transport-security: max-age=31536000;includeSubDomains
content-language: en
access-control-allow-headers: Content-Type, api_key, Authorization, X-ID-TENANT-NAME, X-USER-IDENTITY-DOMAIN-NAME
access-control-allow-methods: GET, POST, DELETE, PUT, OPTIONS, HEAD
x-oracle-dms-ecid: 005KBGCCig46uHFpR05Eid0007dd0002K9
x-oracle-dms-ecid: 005KBGCCig46uHFpR05Eid0007dd0002K9
access-control-allow-origin: *
x-frame-options: DENY
content-type: application/json
vary: user-agent
date: Tue, 30 May 2017 01:51:53 GMT
content-length: 812

Response Body

{
	"items": [{
			"identityDomain": "usexample",
			"serviceType": "dbaas",
			"serviceName": "db12c",
			"credName": "vmspublickey",
			"credType": "SSH",
			"description": "Service user ssh public key which can be used to access the service VM instances",
			"canonicalUrl": "https:\/\/dbaas.oraclecloud.com:443\/paas\/api\/v1.1\/instancemgmt\/usexample\/services\/dbaas\/instances\/db12c\/credentials\/crednames\/vmspublickey"
		}, {
			"identityDomain": "usexample",
			"serviceType": "dbaas",
			"serviceName": "starter12c",
			"credName": "vmspublickey",
			"credType": "SSH",
			"description": "Service user ssh public key which can be used to access the service VM instances",
			"canonicalUrl": "https:\/\/dbaas.oraclecloud.com:443\/paas\/api\/v1.1\/instancemgmt\/usexample\/services\/dbaas\/instances\/starter12c\/credentials\/crednames\/vmspublickey"
		}
	],
	"hasMore": false,
	"totalResults": 2
}

Back to Top