find_apisBrowse and filter every API in the catalog.
get_api_artifactsOne API's artifacts, grouped by type.
get_openapiThe primary OpenAPI for this API.
find_similar_apisAPIs that look like this one.
apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
resolveTurn a domain, URL or GitHub org into the provider it belongs to.
find_cohortsEvery scored population of providers in the catalog.

All 92 tools →

Call it yourself

curl for this page

This API

curl "https://apis.io/api/v1/apis/amazon-iam:amazon-iam-ssh-public-key-api"

All apis

curl "https://apis.io/api/v1/apis?limit=25"

Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

openapi: 3.2.0
info:
  title: AWS Identity and Access Management Ssh Public Key API
  version: '2010-05-08'
  description: Generated from AWS's published Smithy model for AWS Identity and Access Management. 4 operation(s).
  contact:
    name: Amazon Web Services
    url: https://aws.amazon.com/contact-us/
  license:
    name: Apache 2.0
    identifier: Apache-2.0
    url: https://github.com/aws/api-models-aws/blob/main/LICENSE
servers:
- url: https://iam.{region}.amazonaws.com
  variables:
    region:
      default: us-east-1
security:
- sigv4: []
tags:
- name: Ssh Public Key
paths:
  /?Action=DeleteSSHPublicKey:
    post:
      operationId: DeleteSSHPublicKey
      summary: Delete SSHPublic Key
      description: Deletes the specified SSH public key. The SSH public key deleted by this operation is used only for authenticating the associated IAM user to an CodeCommit repository. For more information about using SSH keys to authenticate to an CodeCommit repository, see Set up CodeCommit for SSH connections in the CodeCommit User Guide.
      responses:
        '200':
          description: Success
          content:
            text/xml:
              schema:
                type: string
        '404':
          description: NoSuchEntityException
          content:
            text/xml:
              schema:
                $ref: '#/components/schemas/NoSuchEntityException'
      requestBody:
        required: true
        content:
          application/x-www-form-urlencoded:
            schema:
              allOf:
              - type: object
                required:
                - Action
                - Version
                properties:
                  Action:
                    type: string
                    const: DeleteSSHPublicKey
                  Version:
                    type: string
                    const: '2010-05-08'
              - $ref: '#/components/schemas/DeleteSSHPublicKeyRequest'
      tags:
      - Ssh Public Key
  /?Action=GetSSHPublicKey:
    post:
      operationId: GetSSHPublicKey
      summary: Get SSHPublic Key
      description: Retrieves the specified SSH public key, including metadata about the key. The SSH public key retrieved by this operation is used only for authenticating the associated IAM user to an CodeCommit repository. For more information about using SSH keys to authenticate to an CodeCommit repository, see Set up CodeCommit for SSH connections in the CodeCommit User Guide.
      responses:
        '200':
          description: Success
          content:
            text/xml:
              schema:
                $ref: '#/components/schemas/GetSSHPublicKeyResponse'
        '404':
          description: NoSuchEntityException
          content:
            text/xml:
              schema:
                $ref: '#/components/schemas/NoSuchEntityException'
        '400':
          description: UnrecognizedPublicKeyEncodingException
          content:
            text/xml:
              schema:
                $ref: '#/components/schemas/UnrecognizedPublicKeyEncodingException'
      requestBody:
        required: true
        content:
          application/x-www-form-urlencoded:
            schema:
              allOf:
              - type: object
                required:
                - Action
                - Version
                properties:
                  Action:
                    type: string
                    const: GetSSHPublicKey
                  Version:
                    type: string
                    const: '2010-05-08'
              - $ref: '#/components/schemas/GetSSHPublicKeyRequest'
      tags:
      - Ssh Public Key
  /?Action=ListSSHPublicKeys:
    post:
      operationId: ListSSHPublicKeys
      summary: List SSHPublic Keys
      description: Returns information about the SSH public keys associated with the specified IAM user. If none exists, the operation returns an empty list. The SSH public keys returned by this operation are used only for authenticating the IAM user to an CodeCommit repository. For more information about using SSH keys to authenticate to an CodeCommit repository, see Set up CodeCommit for SSH connections in the CodeCommit User Guide. Although each user is limited to a small number of keys, you can still paginate the results using the MaxItems and Marker parameters.
      responses:
        '200':
          description: Success
          content:
            text/xml:
              schema:
                $ref: '#/components/schemas/ListSSHPublicKeysResponse'
        '404':
          description: NoSuchEntityException
          content:
            text/xml:
              schema:
                $ref: '#/components/schemas/NoSuchEntityException'
      requestBody:
        required: true
        content:
          application/x-www-form-urlencoded:
            schema:
              allOf:
              - type: object
                required:
                - Action
                - Version
                properties:
                  Action:
                    type: string
                    const: ListSSHPublicKeys
                  Version:
                    type: string
                    const: '2010-05-08'
              - $ref: '#/components/schemas/ListSSHPublicKeysRequest'
      tags:
      - Ssh Public Key
  /?Action=UpdateSSHPublicKey:
    post:
      operationId: UpdateSSHPublicKey
      summary: Update SSHPublic Key
      description: Sets the status of an IAM user's SSH public key to active or inactive. SSH public keys that are inactive cannot be used for authentication. This operation can be used to disable a user's SSH public key as part of a key rotation work flow. The SSH public key affected by this operation is used only for authenticating the associated IAM user to an CodeCommit repository. For more information about using SSH keys to authenticate to an CodeCommit repository, see Set up CodeCommit for SSH connections in the CodeCommit User Guide.
      responses:
        '200':
          description: Success
          content:
            text/xml:
              schema:
                type: string
        '400':
          description: InvalidInputException
          content:
            text/xml:
              schema:
                $ref: '#/components/schemas/InvalidInputException'
        '404':
          description: NoSuchEntityException
          content:
            text/xml:
              schema:
                $ref: '#/components/schemas/NoSuchEntityException'
      requestBody:
        required: true
        content:
          application/x-www-form-urlencoded:
            schema:
              allOf:
              - type: object
                required:
                - Action
                - Version
                properties:
                  Action:
                    type: string
                    const: UpdateSSHPublicKey
                  Version:
                    type: string
                    const: '2010-05-08'
              - $ref: '#/components/schemas/UpdateSSHPublicKeyRequest'
      tags:
      - Ssh Public Key
components:
  schemas:
    SSHPublicKeyMetadata:
      type: object
      properties:
        UserName:
          type: string
          description: The name of the IAM user associated with the SSH public key.
        SSHPublicKeyId:
          type: string
          description: The unique identifier for the SSH public key.
        Status:
          type: string
          enum:
          - Active
          - Inactive
          - Expired
          description: The status of the SSH public key. Active means that the key can be used for authentication with an CodeCommit repository. Inactive means that the key cannot be used.
        UploadDate:
          type: string
          format: date-time
          description: The date and time, in ISO 8601 date-time format, when the SSH public key was uploaded.
      required:
      - UserName
      - SSHPublicKeyId
      - Status
      - UploadDate
    ListSSHPublicKeysRequest:
      type: object
      properties:
        UserName:
          type: string
          description: 'The name of the IAM user to list SSH public keys for. If none is specified, the UserName field is determined implicitly based on the Amazon Web Services access key used to sign the request. This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-'
        Marker:
          type: string
          description: Use this parameter only when paginating results and only after you receive a response indicating that the results are truncated. Set it to the value of the Marker element in the response that you received to indicate where the next call should start.
        MaxItems:
          type: integer
          description: Use this only when paginating results to indicate the maximum number of items you want in the response. If additional items exist beyond the maximum you specify, the IsTruncated response element is true. If you do not include this parameter, the number of items defaults to 100. Note that IAM might return fewer results, even when there are more results available. In that case, the IsTruncated response element returns true, and Marker contains a value to include in the subsequent call that tells the service where to continue from.
    GetSSHPublicKeyRequest:
      type: object
      properties:
        UserName:
          type: string
          description: 'The name of the IAM user associated with the SSH public key. This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-'
        SSHPublicKeyId:
          type: string
          description: The unique identifier for the SSH public key. This parameter allows (through its regex pattern) a string of characters that can consist of any upper or lowercased letter or digit.
        Encoding:
          type: string
          enum:
          - SSH
          - PEM
          description: Specifies the public key encoding format to use in the response. To retrieve the public key in ssh-rsa format, use SSH. To retrieve the public key in PEM format, use PEM.
      required:
      - UserName
      - SSHPublicKeyId
      - Encoding
    ListSSHPublicKeysResponse:
      type: object
      properties:
        SSHPublicKeys:
          type: array
          items:
            $ref: '#/components/schemas/SSHPublicKeyMetadata'
          description: A list of the SSH public keys assigned to IAM user.
        IsTruncated:
          type: boolean
          description: A flag that indicates whether there are more items to return. If your results were truncated, you can make a subsequent pagination request using the Marker request parameter to retrieve more items. Note that IAM might return fewer than the MaxItems number of results even when there are more results available. We recommend that you check IsTruncated after every call to ensure that you receive all your results.
        Marker:
          type: string
          description: When IsTruncated is true, this element is present and contains the value to use for the Marker parameter in a subsequent pagination request.
    SSHPublicKey:
      type: object
      properties:
        UserName:
          type: string
          description: The name of the IAM user associated with the SSH public key.
        SSHPublicKeyId:
          type: string
          description: The unique identifier for the SSH public key.
        Fingerprint:
          type: string
          description: The MD5 message digest of the SSH public key.
        SSHPublicKeyBody:
          type: string
          description: The SSH public key.
        Status:
          type: string
          enum:
          - Active
          - Inactive
          - Expired
          description: The status of the SSH public key. Active means that the key can be used for authentication with an CodeCommit repository. Inactive means that the key cannot be used.
        UploadDate:
          type: string
          format: date-time
          description: The date and time, in ISO 8601 date-time format, when the SSH public key was uploaded.
      required:
      - UserName
      - SSHPublicKeyId
      - Fingerprint
      - SSHPublicKeyBody
      - Status
    NoSuchEntityException:
      type: object
      properties:
        message:
          type: string
    InvalidInputException:
      type: object
      properties:
        message:
          type: string
    UnrecognizedPublicKeyEncodingException:
      type: object
      properties:
        message:
          type: string
    DeleteSSHPublicKeyRequest:
      type: object
      properties:
        UserName:
          type: string
          description: 'The name of the IAM user associated with the SSH public key. This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-'
        SSHPublicKeyId:
          type: string
          description: The unique identifier for the SSH public key. This parameter allows (through its regex pattern) a string of characters that can consist of any upper or lowercased letter or digit.
      required:
      - UserName
      - SSHPublicKeyId
    GetSSHPublicKeyResponse:
      type: object
      properties:
        SSHPublicKey:
          $ref: '#/components/schemas/SSHPublicKey'
    UpdateSSHPublicKeyRequest:
      type: object
      properties:
        UserName:
          type: string
          description: 'The name of the IAM user associated with the SSH public key. This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-'
        SSHPublicKeyId:
          type: string
          description: The unique identifier for the SSH public key. This parameter allows (through its regex pattern) a string of characters that can consist of any upper or lowercased letter or digit.
        Status:
          type: string
          enum:
          - Active
          - Inactive
          - Expired
          description: The status to assign to the SSH public key. Active means that the key can be used for authentication with an CodeCommit repository. Inactive means that the key cannot be used.
      required:
      - UserName
      - SSHPublicKeyId
      - Status
  securitySchemes:
    sigv4:
      type: apiKey
      in: header
      name: Authorization
      description: AWS Signature Version 4. The Authorization header carries an AWS4-HMAC-SHA256 signature over the canonical request, with X-Amz-Date (and X-Amz-Security-Token for temporary credentials). Not a bearer token.
      x-aws-sigv4:
        signingName: iam
x-provenance:
  method: harvested
  publisher: Amazon Web Services
  source: https://raw.githubusercontent.com/aws/api-models-aws/582e55931c45b944739742a2c1620b6026dd2d13/models/iam/service/2010-05-08/iam-2010-05-08.json
  note: converted by smithy-to-openapi.py from AWS's Smithy model (roadmap#1001)