Modifier une règle d’accès API

Vous pouvez modifier la description et la plage d’IP d’une règle d’accès API.

Modifier une règle d’accès API avec Cockpit v2

La nouvelle règle que vous renseignez remplace intégralement l’ancienne règle. Pour un paramètre qui n’est pas renseigné, toute valeur précédemment définie est supprimée.

En cas de perte d’accès aux API suite à vos modifications, vous devez contacter l’équipe Support. Pour en savoir plus, voir Support technique.

Dans le coin supérieur droit, cliquez sur l’icône .
Un menu déroulant apparaît.
Cliquez sur Règles d’accès API.
La liste de vos règles d’accès API apparaît.
Cochez la case de la règle d’accès API que vous voulez modifier.
La règle d’accès API est sélectionnée.
Cliquez sur Modifier.
La boîte de dialogue MODIFIER UNE RÈGLE D’ACCÈS API apparaît.
(optionnel) Dans le champ Description, tapez une description pour la règle d’accès API.
Dans le champ Plage d’IP, tapez une plage d’IP pour la règle d’accès API, en notation CIDR.

Si le bouton Mon IP ne fonctionne pas, vérifiez si une extension de navigateur bloque des scripts sur la page.
Cliquez sur Modifier.
La règle d’accès API est modifiée.

Modifier une règle d’accès API avec OSC CLI

À ce jour, cette section est disponible en anglais uniquement.

The UpdateApiAccessRule command modifies a specified API access rule.

The new rule you specify fully replaces the old rule. Therefore, for a parameter that is not specified, any previously set value is deleted.
If, as result of your modification, you no longer have access to the APIs, you will need to contact the Support team to regain access. For more information, see Technical Support.

Request sample: Example with access key/secret key authentication

$ osc-cli api UpdateApiAccessRule --profile "default" \
    --ApiAccessRuleId "aar-1234567890abcdef1234567890abcdef" \
    --IpRanges '["0.0.0.0/0"]' \
    --Description "Allows all Ipv4 domain"

Request sample: Example with login/password authentication

$ osc-cli api UpdateApiAccessRule --profile "default" --authentication-method "password" --login "$OSC_EMAIL" --password "$OSC_PASSWORD" \
    --ApiAccessRuleId "aar-1234567890abcdef1234567890abcdef" \
    --IpRanges '["0.0.0.0/0"]' \
    --Description "Allows all Ipv4 domain"

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

ApiAccessRuleId: The ID of the API access rule you want to update.
CaIds: (optional) One or more IDs of Client Certificate Authorities (CAs).
Cns: (optional) One or more Client Certificate Common Names (CNs).
Description: (optional) A new description for the API access rule.
DryRun: (optional) If true, checks whether you have the required permissions to perform the action.
IpRanges: (optional) One or more IPs or CIDR blocks (for example, 192.0.2.0/16).

The UpdateApiAccessRule command returns the following elements:

ApiAccessRule: Information about the API access rule.
- ApiAccessRuleId: The ID of the API access rule.
- CaIds: One or more IDs of Client Certificate Authorities (CAs) used for the API access rule.
- Cns: One or more Client Certificate Common Names (CNs).
- Description: The description of the API access rule.
- IpRanges: One or more IP ranges used for the API access rule, in CIDR notation (for example, 192.0.2.0/16).
ResponseContext: Information about the context of the response.
- RequestId: The ID of the request.

Result sample

{
  "ResponseContext": {
    "RequestId": "0475ca1e-d0c5-441d-712a-da55a4175157"
  },
  "ApiAccessRule": {
    "IpRanges": [
      "0.0.0.0/0"
    ],
    "ApiAccessRuleId": "aar-1234567890abcdef1234567890abcdef",
    "CaIds": [],
    "Cns": [],
    "Description": "Allows all IPv4 domain"
  }
}

Modifier une règle d’accès API avec oapi-cli