Skip to main content

Bulk Set User Metadata​

Add or update multiple metadata values for a user. Make sure the values are base64 encoded.

Path Parameters
  • id string required
Header Parameters
  • x-zitadel-orgid string

    The default is always the organization of the requesting user. If you like to get users of another organization include the header. Make sure the user has permission to access the requested data.

Request Body required
  • metadata object[]

    The values have to be base64 encoded.

  • Array [
  • key string
  • value byte
  • ]
Responses

A successful response.

Schema
  • details object
  • sequence uint64

    on read: the sequence of the last event reduced by the projection

    on manipulation: the timestamp of the event(s) added by the manipulation

  • creationDate date-time

    on read: the timestamp of the first event of the object

    on create: the timestamp of the event(s) added by the manipulation

  • changeDate date-time

    on read: the timestamp of the last event reduced by the projection

    on manipulation: the

  • resourceOwner resource_owner is the organization an object belongs to
POST /users/:id/metadata/_bulk

Authorization

type: oauth2flow: authorizationCodescopes: openid,urn:zitadel:iam:org:project:id:zitadel:aud

Request

Base URL
https://$ZITADEL_DOMAIN/management/v1
Bearer Token
id — path required
x-zitadel-orgid — header
Content-Type
Body required
{

  "metadata": [

    {

      "key": "test1",

      "value": "VGhpcyBpcyBteSBmaXJzdCB2YWx1ZQ=="

    },

    {

      "key": "test2",

      "value": "VGhpcyBpcyBteSBzZWNvbmQgdmFsdWU="

    }

  ]

}
Accept
curl -L -X POST 'https://$ZITADEL_DOMAIN/management/v1/users/:id/metadata/_bulk' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <TOKEN>' \
--data-raw '{
  "metadata": [
    {
      "key": "test1",
      "value": "VGhpcyBpcyBteSBmaXJzdCB2YWx1ZQ=="
    },
    {
      "key": "test2",
      "value": "VGhpcyBpcyBteSBzZWNvbmQgdmFsdWU="
    }
  ]
}'