Can't I create a custom client key?

[datamaker]

Whenever you update the version of meilisearch, you need to change the client key specified in the frontend. Is it possible to customize the key value when generating the key?

[oluademola]

Hello @datamaker

You are right; this happens after an update. I am afraid we do not provide options to customize these values when generating the keys because these are default keys generated by Meilisearch; however, it is possible to update these keys. Of course, you have options for user-created keys.

Hope this helps.

[datamaker]

@oluademola Thanks for the quick reply.

I tried the test to see if the "key" value would change with the key update function, but it didn't work. Is it correct to make it immutable?

[oluademola]

Hi @datamaker

The key attribute cannot be modified. You can only update the description, actions, indexes, or expiresAt attribute of an API key. The key attribute is not included or supported in the payload

[gmourier]

Hi @datamaker and @oluademola 👋

It will be possible to do that with the next v0.28 version

Meilisearch introduces anuid field which can be given at the creation time of the key (not at the update). If this field is not given Meilisearch generates its value automatically (it's an uuid v4).

This will allows having determinist key values if you provides uid it to Meilisearch. The resulting key value of the API key is a hash combination between the unique uid and the master-key.

Note that if you use the dump process to load the old data into a new version of Meilisearch, the key values are kept, you just need to have the same master key.

[datamaker]

@gmourier I upgraded 0.28 in the development environment and confirmed the uid upgrade. It works fine! Thank you so much. 👍👍

[gmourier]

Glad to hear that @datamaker. Thanks for the sharing!

[ngdbao]

Thanks, it works

Also, took a while to find out how to provide uid when creating key

This is my snippet:

    const newkey = await client.createKey(
        {
            name: 'dev',
            description: 'for dev environment frontend',
            uid: 'xxxx-aaaa-bbbb-ccccc-dddd',
            actions: ["search"],
            indexes: ["a", "b", "c"],
            expiresAt: "2043-01-01T00:00:00Z"
        }
    )
    ```