Issue Service User Api Key

Membership.

A contact (user) is a person in your project's membership directory, with one or more linked logins (identities). Membership manages their profile, identities, roles, and lifecycle.

Issues the service user api key.

Membership

post

Authorizations

HTTPRequired

JWT Bearer Authorization

Path parameters

versionstring · nullableRequired

The CodeMash API version used to fetch data from the API. If not specified, the last version will be used. E.g.: v3

IdstringRequired

Body

Membership

correlationIdstring · nullableOptional

CorrelationId for each request

cultureCodestring · nullableOptional

Specify culture code when your response from the API should be localised. E.g.: en

timeZoneIdstring · nullableOptional

TimeZone

envstring · nullableOptional

Target environment for this request (e.g. TEST, STAGING). Optional — when omitted the request runs against PROD. Can be passed in a header as norbix-env.

projectIdstringRequired

ID of your project. Can be passed in a header as norbix-project-id.

databaseIntegrationIdstring · nullableOptional

expiresInDaysinteger · int32 · nullableOptional

namestringOptional

notesstring · nullableOptional

scopesstring[] · nullableOptional

Responses

200

OK

application/json

idinteger · int32Optional

namestring · nullableOptional

keystring · nullableOptional

post/{version}/membership/users/{Id}/api-keys

POST /{version}/membership/users/{Id}/api-keys HTTP/1.1
Host: hub.norbix.ai
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: multipart/form-data
Accept: */*
Content-Length: 193

{
  "correlationId": "text",
  "cultureCode": "text",
  "timeZoneId": "text",
  "env": "text",
  "projectId": "text",
  "databaseIntegrationId": "text",
  "expiresInDays": 1,
  "name": "text",
  "notes": "text",
  "scopes": [
    "text"
  ]
}

200

OK

{
  "id": 1,
  "name": "text",
  "key": "text"
}

In the dashboard

Manage this visually in Norbix Cloud — see Membership → Users.

Use it from code

Every Norbix SDK exposes this endpoint as a method — see Issue Service User Api Key in the SDK reference, with examples in every language.