Managing CAs

You can manage certificate authorities (CAs) for use as criteria in your API access rules. For more information, see About API Access Rules.

The use of Certificate Authorities (CAs) for API access rules is deprecated and will reach its end-of-life by the end of June 2027. You should only use API access rules for IP filtering. You can still protect the use of certain API calls via an API access policy and a trusted session. For more information, see About Your API Access Policy.

Managing CAs Using octl

Creating a CA

The use of Certificate Authorities (CAs) for API access rules is deprecated and will reach its end-of-life by the end of June 2027.

The CreateCa command creates a Client Certificate Authority (CA).

For more information, see About API Access Rules. > Deprecated: This call is deprecated and will be removed.

Request sample
$ octl iaas api CreateCa --profile "default" \
  --CaPem ca-certificate.pem \
  --Description "CA example"

This command contains the following options that you need to specify:

  • CaPem: The CA in PEM format.

  • Description: (optional) The description of the CA.

  • DryRun: (optional) If true, checks whether you have the required permissions to perform the action.

The CreateCa command returns the following elements:

  • Ca: Information about the Client Certificate Authority (CA).

    • CaFingerprint: The fingerprint of the CA.

    • CaId: The ID of the CA.

    • Description: The description of the CA.

  • ResponseContext: Information about the context of the response.

    • RequestId: The ID of the request.

Result sample
{
  "ResponseContext": {
    "RequestId": "0475ca1e-d0c5-441d-712a-da55a4175157"
  },
  "Ca": {
    "Description": "CA example",
    "CaId": "ca-fedcba0987654321fedcba0987654321",
    "CaFingerprint": "1234567890abcdef1234567890abcdef12345678"
  }
}

Getting Information About Your CAs

The use of Certificate Authorities (CAs) for API access rules is deprecated and will reach its end-of-life by the end of June 2027.

The ReadCas command gets information about one or more of your Client Certificate Authorities (CAs). > Deprecated: This call is deprecated and will be removed.

Request sample
$ octl iaas api ReadCas --profile "default" \
  --Filters.CaIds "ca-fedcba0987654321fedcba0987654321"

This command contains the following options that you need to specify:

  • DryRun: (optional) If true, checks whether you have the required permissions to perform the action.

  • Filters.CaFingerprints: (optional) The fingerprints of the CAs.

  • Filters.CaIds: (optional) The IDs of the CAs.

  • Filters.Descriptions: (optional) The descriptions of the CAs.

The ReadCas command returns the following elements:

  • Cas: Information about one or more CAs.

    • CaFingerprint: The fingerprint of the CA.

    • CaId: The ID of the CA.

    • Description: The description of the CA.

  • ResponseContext: Information about the context of the response.

    • RequestId: The ID of the request.

Result sample
{
  "ResponseContext": {
    "RequestId": "0475ca1e-d0c5-441d-712a-da55a4175157"
  },
  "Cas": [
    {
      "Description": "CA example",
      "CaId": "ca-fedcba0987654321fedcba0987654321",
      "CaFingerprint": "1234567890abcdef1234567890abcdef12345678"
    }
  ]
}

Modifying a CA

The use of Certificate Authorities (CAs) for API access rules is deprecated and will reach its end-of-life by the end of June 2027.

The UpdateCa command modifies the specified attribute of a Client Certificate Authority (CA). > Deprecated: This call is deprecated and will be removed.

Request sample
$ octl iaas api UpdateCa --profile "default" \
  --CaId "ca-fedcba0987654321fedcba0987654321" \
  --Description "New description"

This command contains the following options that you need to specify:

  • CaId: The ID of the CA.

  • Description: (optional) The description of the CA.

  • DryRun: (optional) If true, checks whether you have the required permissions to perform the action.

The UpdateCa command returns the following elements:

  • Ca: Information about the Client Certificate Authority (CA).

    • CaFingerprint: The fingerprint of the CA.

    • CaId: The ID of the CA.

    • Description: The description of the CA.

  • ResponseContext: Information about the context of the response.

    • RequestId: The ID of the request.

Result sample
{
  "ResponseContext": {
    "RequestId": "0475ca1e-d0c5-441d-712a-da55a4175157"
  },
  "Ca": {
    "Description": "New description",
    "CaId": "ca-fedcba0987654321fedcba0987654321",
    "CaFingerprint": "1234567890abcdef1234567890abcdef12345678"
  }
}

Deleting a CA

The DeleteCa command deletes a specified Client Certificate Authority (CA). > Deprecated: This call is deprecated and will be removed.

Request sample
$ octl iaas api DeleteCa --profile "default" \
  --CaId "ca-fedcba0987654321fedcba0987654321"

This command contains the following options that you need to specify:

  • CaId: The ID of the CA you want to delete.

  • DryRun: (optional) If true, checks whether you have the required permissions to perform the action.

The DeleteCa command returns the following elements:

  • ResponseContext: Information about the context of the response.

    • RequestId: The ID of the request.

Result sample
{
  "ResponseContext": {
    "RequestId": "0475ca1e-d0c5-441d-712a-da55a4175157"
  }
}

Managing CAs Using OSC CLI

Creating a CA

The use of Certificate Authorities (CAs) for API access rules is deprecated and will reach its end-of-life by the end of June 2027.

The CreateCa command creates a Client Certificate Authority (CA).

For more information, see About API Access Rules. > Deprecated: This call is deprecated and will be removed.

Request sample: Example with access key/secret key authentication
$ osc-cli api CreateCa --profile "default" \
    --CaPem="$(cat ca-certificate.pem)" \
    --Description "CA example"
Request sample: Example with login/password authentication
$ osc-cli api CreateCa --profile "default" --authentication-method "password" --login "$OSC_LOGIN" --password "$OSC_PASSWORD" \
    --CaPem="$(cat ca-certificate.pem)" \
    --Description "CA example"

Note regarding --CaPem:
With OSC CLI, make sure you use this syntax: --CaPem=$(cat FILENAME.pem).

This command contains the following options that you need to specify:

  • CaPem: The CA in PEM format.

  • Description: (optional) The description of the CA.

  • DryRun: (optional) If true, checks whether you have the required permissions to perform the action.

The CreateCa command returns the following elements:

  • Ca: Information about the Client Certificate Authority (CA).

    • CaFingerprint: The fingerprint of the CA.

    • CaId: The ID of the CA.

    • Description: The description of the CA.

  • ResponseContext: Information about the context of the response.

    • RequestId: The ID of the request.

Result sample
{
  "ResponseContext": {
    "RequestId": "0475ca1e-d0c5-441d-712a-da55a4175157"
  },
  "Ca": {
    "Description": "CA example",
    "CaId": "ca-fedcba0987654321fedcba0987654321",
    "CaFingerprint": "1234567890abcdef1234567890abcdef12345678"
  }
}

Getting Information About Your CAs

The use of Certificate Authorities (CAs) for API access rules is deprecated and will reach its end-of-life by the end of June 2027.

The ReadCas command gets information about one or more of your Client Certificate Authorities (CAs). > Deprecated: This call is deprecated and will be removed.

Request sample: Example with access key/secret key authentication
$ osc-cli api ReadCas --profile "default" \
    --Filters '{
        "CaIds": ["ca-fedcba0987654321fedcba0987654321"]
      }'
Request sample: Example with login/password authentication
$ osc-cli api ReadCas --profile "default" --authentication-method "password" --login "$OSC_LOGIN" --password "$OSC_PASSWORD" \
    --Filters '{
        "CaIds": ["ca-fedcba0987654321fedcba0987654321"]
      }'

This command contains the following options that you need to specify:

  • DryRun: (optional) If true, checks whether you have the required permissions to perform the action.

  • Filters: (optional) One or more filters.

    • CaFingerprints: (optional) The fingerprints of the CAs.

    • CaIds: (optional) The IDs of the CAs.

    • Descriptions: (optional) The descriptions of the CAs.

The ReadCas command returns the following elements:

  • Cas: Information about one or more CAs.

    • CaFingerprint: The fingerprint of the CA.

    • CaId: The ID of the CA.

    • Description: The description of the CA.

  • ResponseContext: Information about the context of the response.

    • RequestId: The ID of the request.

Result sample
{
  "ResponseContext": {
    "RequestId": "0475ca1e-d0c5-441d-712a-da55a4175157"
  },
  "Cas": [
    {
      "Description": "CA example",
      "CaId": "ca-fedcba0987654321fedcba0987654321",
      "CaFingerprint": "1234567890abcdef1234567890abcdef12345678"
    }
  ]
}

Modifying a CA

The use of Certificate Authorities (CAs) for API access rules is deprecated and will reach its end-of-life by the end of June 2027.

The UpdateCa command modifies the specified attribute of a Client Certificate Authority (CA). > Deprecated: This call is deprecated and will be removed.

Request sample: Example with access key/secret key authentication
$ osc-cli api UpdateCa --profile "default" \
    --CaId "ca-fedcba0987654321fedcba0987654321" \
    --Description "New description"
Request sample: Example with login/password authentication
$ osc-cli api UpdateCa --profile "default" --authentication-method "password" --login "$OSC_LOGIN" --password "$OSC_PASSWORD" \
    --CaId "ca-fedcba0987654321fedcba0987654321" \
    --Description "New description"

This command contains the following options that you need to specify:

  • CaId: The ID of the CA.

  • Description: (optional) The description of the CA.

  • DryRun: (optional) If true, checks whether you have the required permissions to perform the action.

The UpdateCa command returns the following elements:

  • Ca: Information about the Client Certificate Authority (CA).

    • CaFingerprint: The fingerprint of the CA.

    • CaId: The ID of the CA.

    • Description: The description of the CA.

  • ResponseContext: Information about the context of the response.

    • RequestId: The ID of the request.

Result sample
{
  "ResponseContext": {
    "RequestId": "0475ca1e-d0c5-441d-712a-da55a4175157"
  },
  "Ca": {
    "Description": "New description",
    "CaId": "ca-fedcba0987654321fedcba0987654321",
    "CaFingerprint": "1234567890abcdef1234567890abcdef12345678"
  }
}

Deleting a CA

The DeleteCa command deletes a specified Client Certificate Authority (CA). > Deprecated: This call is deprecated and will be removed.

Request sample: Example with access key/secret key authentication
$ osc-cli api DeleteCa --profile "default" \
    --CaId "ca-fedcba0987654321fedcba0987654321"
Request sample: Example with login/password authentication
$ osc-cli api DeleteCa --profile "default" --authentication-method "password" --login "$OSC_LOGIN" --password "$OSC_PASSWORD" \
    --CaId "ca-fedcba0987654321fedcba0987654321"

This command contains the following options that you need to specify:

  • CaId: The ID of the CA you want to delete.

  • DryRun: (optional) If true, checks whether you have the required permissions to perform the action.

The DeleteCa command returns the following elements:

  • ResponseContext: Information about the context of the response.

    • RequestId: The ID of the request.

Result sample
{
  "ResponseContext": {
    "RequestId": "0475ca1e-d0c5-441d-712a-da55a4175157"
  }
}

Managing CAs Using oapi-cli

Creating a CA

The use of Certificate Authorities (CAs) for API access rules is deprecated and will reach its end-of-life by the end of June 2027.

The CreateCa command creates a Client Certificate Authority (CA).

For more information, see About API Access Rules. > Deprecated: This call is deprecated and will be removed.

Request sample: Example with access key/secret key authentication
$ oapi-cli --profile "default" CreateCa \
    --CaPem --file "ca-certificate.pem" \
    --Description "CA example"
Request sample: Example with login/password authentication
$ oapi-cli --profile "default" --login "$OSC_LOGIN" --password "$OSC_PASSWORD" CreateCa \
    --CaPem --file "ca-certificate.pem" \
    --Description "CA example"

This command contains the following options that you need to specify:

  • CaPem: The CA in PEM format.

  • Description: (optional) The description of the CA.

  • DryRun: (optional) If true, checks whether you have the required permissions to perform the action.

The CreateCa command returns the following elements:

  • Ca: Information about the Client Certificate Authority (CA).

    • CaFingerprint: The fingerprint of the CA.

    • CaId: The ID of the CA.

    • Description: The description of the CA.

  • ResponseContext: Information about the context of the response.

    • RequestId: The ID of the request.

Result sample
{
  "ResponseContext": {
    "RequestId": "0475ca1e-d0c5-441d-712a-da55a4175157"
  },
  "Ca": {
    "Description": "CA example",
    "CaId": "ca-fedcba0987654321fedcba0987654321",
    "CaFingerprint": "1234567890abcdef1234567890abcdef12345678"
  }
}

Getting Information About Your CAs

The use of Certificate Authorities (CAs) for API access rules is deprecated and will reach its end-of-life by the end of June 2027.

The ReadCas command gets information about one or more of your Client Certificate Authorities (CAs). > Deprecated: This call is deprecated and will be removed.

Request sample: Example with access key/secret key authentication
$ oapi-cli --profile "default" ReadCas \
    --Filters '{
        "CaIds": ["ca-fedcba0987654321fedcba0987654321"]
      }'
Request sample: Example with login/password authentication
$ oapi-cli --profile "default" --login "$OSC_LOGIN" --password "$OSC_PASSWORD" ReadCas \
    --Filters '{
        "CaIds": ["ca-fedcba0987654321fedcba0987654321"]
      }'

This command contains the following options that you need to specify:

  • DryRun: (optional) If true, checks whether you have the required permissions to perform the action.

  • Filters: (optional) One or more filters.

    • CaFingerprints: (optional) The fingerprints of the CAs.

    • CaIds: (optional) The IDs of the CAs.

    • Descriptions: (optional) The descriptions of the CAs.

The ReadCas command returns the following elements:

  • Cas: Information about one or more CAs.

    • CaFingerprint: The fingerprint of the CA.

    • CaId: The ID of the CA.

    • Description: The description of the CA.

  • ResponseContext: Information about the context of the response.

    • RequestId: The ID of the request.

Result sample
{
  "ResponseContext": {
    "RequestId": "0475ca1e-d0c5-441d-712a-da55a4175157"
  },
  "Cas": [
    {
      "Description": "CA example",
      "CaId": "ca-fedcba0987654321fedcba0987654321",
      "CaFingerprint": "1234567890abcdef1234567890abcdef12345678"
    }
  ]
}

Modifying a CA

The use of Certificate Authorities (CAs) for API access rules is deprecated and will reach its end-of-life by the end of June 2027.

The UpdateCa command modifies the specified attribute of a Client Certificate Authority (CA). > Deprecated: This call is deprecated and will be removed.

Request sample: Example with access key/secret key authentication
$ oapi-cli --profile "default" UpdateCa \
    --CaId "ca-fedcba0987654321fedcba0987654321" \
    --Description "New description"
Request sample: Example with login/password authentication
$ oapi-cli --profile "default" --login "$OSC_LOGIN" --password "$OSC_PASSWORD" UpdateCa \
    --CaId "ca-fedcba0987654321fedcba0987654321" \
    --Description "New description"

This command contains the following options that you need to specify:

  • CaId: The ID of the CA.

  • Description: (optional) The description of the CA.

  • DryRun: (optional) If true, checks whether you have the required permissions to perform the action.

The UpdateCa command returns the following elements:

  • Ca: Information about the Client Certificate Authority (CA).

    • CaFingerprint: The fingerprint of the CA.

    • CaId: The ID of the CA.

    • Description: The description of the CA.

  • ResponseContext: Information about the context of the response.

    • RequestId: The ID of the request.

Result sample
{
  "ResponseContext": {
    "RequestId": "0475ca1e-d0c5-441d-712a-da55a4175157"
  },
  "Ca": {
    "Description": "New description",
    "CaId": "ca-fedcba0987654321fedcba0987654321",
    "CaFingerprint": "1234567890abcdef1234567890abcdef12345678"
  }
}

Deleting a CA

The DeleteCa command deletes a specified Client Certificate Authority (CA). > Deprecated: This call is deprecated and will be removed.

Request sample: Example with access key/secret key authentication
$ oapi-cli --profile "default" DeleteCa \
    --CaId "ca-fedcba0987654321fedcba0987654321"
Request sample: Example with login/password authentication
$ oapi-cli --profile "default" --login "$OSC_LOGIN" --password "$OSC_PASSWORD" DeleteCa \
    --CaId "ca-fedcba0987654321fedcba0987654321"

This command contains the following options that you need to specify:

  • CaId: The ID of the CA you want to delete.

  • DryRun: (optional) If true, checks whether you have the required permissions to perform the action.

The DeleteCa command returns the following elements:

  • ResponseContext: Information about the context of the response.

    • RequestId: The ID of the request.

Result sample
{
  "ResponseContext": {
    "RequestId": "0475ca1e-d0c5-441d-712a-da55a4175157"
  }
}

Related Page

Corresponding API Methods