Skip to main content

Update API key

PUT 
/v2/config/admin/apikey/:apiKeyId

Updates the name, the scopes and the lifetime of an API key.

The service builds a new token on every update. The token that you had before the update stops working, so replace it in every client that uses it. The new lifetime starts at the moment of the update.

The service reads only name, scopes and expiryInDays from the request. It keeps the current name when name is absent or holds spaces only. It replaces the scopes with the list that you send.

This operation does not change the sandbox organisation of the key. To change it, use PUT /config/admin/apikey/{apiKeyId}/sandbox-org.

Request​

Path Parameters

    apiKeyId stringrequired

    Unique ID of an object

Body

required

The new values of the API key.

    apiKey objectrequired

    The new values of the API key.

    name string

    New name of the API key. The service keeps the current name when you leave this field out or when you send a value of spaces only.

    scopes string[]required

    Possible values: [config, audit, service, onboard]

    New scopes of the API key. The service replaces the current scopes with this list. It refuses any other value with HTTP 400.

    expiryInDays integer

    Default value: 30

    New lifetime of the API key in days, counted from the moment of the update. The service uses 30 days when you leave this field out, or when you send 0 or a negative value.

Responses​

The service updated the API key. The apiKey field of the returned object holds the new signed token.

Response Headers
    Schema
      apiKey objectrequired

      The API key after the update.

      id stringrequired

      Unique identifier of the API key.

      name stringrequired

      Name of the API key. The service does not check this value for uniqueness.

      scopes string[]required

      Possible values: [config, audit, service, onboard]

      Scopes of the API key. Each scope opens a group of endpoints. The service refuses any other value with HTTP 400.

      apiKey stringrequired

      The signed JSON Web Token. Send it as Authorization: ApiKey <apiKey>. The token holds the scopes, the organisation, the organisation administrator and, when the key is bound to a sandbox organisation, the sandbox organisation.

      expiryInDays integerrequired

      Default value: 30

      Lifetime of the API key in days, counted from the moment the service created or last updated the key. The service uses 30 days when you send 0 or a negative value.

      timestamp date-timerequired

      Moment when the service last wrote the API key, in UTC. The service sets this value on create and on every update, including the delete operation.

      expiryTimestamp date-timerequired

      Moment when the API key expires, in UTC.

      type stringrequired

      Possible values: [igrantio, aip10]

      Type of the API key. The list operation returns only keys of type igrantio; these are the keys that you create with this group of operations.

      sandboxOrgId string

      Identifier of the sandbox organisation that the API key is bound to. The field is absent when the key belongs to the main wallet of the organisation.

      createdBy objectrequired

      The user who created the API key, and the moment of creation. The service keeps this as log metadata.

      id stringrequired

      Identifier of the user who created the API key. The value is an empty string for a key created with an API key.

      email stringrequired

      Email address of the user who created the API key.

      at date-timerequired

      Moment of creation, in UTC.

    Loading...
    Last updated on