ServiceSpecificCredential

Contains the details of a service-specific credential.

APIs.ioEngineeringPlatform

Properties

Name Type Description
CreateDate object
ServiceName object
ServiceUserName object
ServicePassword object
ServiceSpecificCredentialId object
UserName object
Status object
View JSON Schema on GitHub

JSON Schema

apis-io-engineering-platform-servicespecificcredential-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/ServiceSpecificCredential",
  "title": "ServiceSpecificCredential",
  "type": "object",
  "required": [
    "CreateDate",
    "ServiceName",
    "ServiceUserName",
    "ServicePassword",
    "ServiceSpecificCredentialId",
    "UserName",
    "Status"
  ],
  "properties": {
    "CreateDate": {
      "allOf": [
        {
          "$ref": "#/components/schemas/dateType"
        },
        {
          "description": "The date and time, in <a href=\"http://www.iso.org/iso/iso8601\">ISO 8601 date-time format</a>, when the service-specific credential were created."
        }
      ]
    },
    "ServiceName": {
      "allOf": [
        {
          "$ref": "#/components/schemas/serviceName"
        },
        {
          "description": "The name of the service associated with the service-specific credential."
        }
      ]
    },
    "ServiceUserName": {
      "allOf": [
        {
          "$ref": "#/components/schemas/serviceUserName"
        },
        {
          "description": "The generated user name for the service-specific credential. This value is generated by combining the IAM user's name combined with the ID number of the Amazon Web Services account, as in <code>jane-at-123456789012</code>, for example. This value cannot be configured by the user."
        }
      ]
    },
    "ServicePassword": {
      "allOf": [
        {
          "$ref": "#/components/schemas/servicePassword"
        },
        {
          "description": "The generated password for the service-specific credential."
        }
      ]
    },
    "ServiceSpecificCredentialId": {
      "allOf": [
        {
          "$ref": "#/components/schemas/serviceSpecificCredentialId"
        },
        {
          "description": "The unique identifier for the service-specific credential."
        }
      ]
    },
    "UserName": {
      "allOf": [
        {
          "$ref": "#/components/schemas/userNameType"
        },
        {
          "description": "The name of the IAM user associated with the service-specific credential."
        }
      ]
    },
    "Status": {
      "allOf": [
        {
          "$ref": "#/components/schemas/statusType"
        },
        {
          "description": "The status of the service-specific credential. <code>Active</code> means that the key is valid for API calls, while <code>Inactive</code> means it is not."
        }
      ]
    }
  },
  "description": "Contains the details of a service-specific credential."
}