Skip to main content

Create Application (API)

POST 
/projects/:projectId/apps/api

Create a new API client. The client id will be generated and returned in the response. Depending on the chosen configuration also a secret will be generated and returned.

Request​

Path Parameters

    projectId stringrequired

Header Parameters

    x-zitadel-orgid string

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

Body

required

    name stringrequired

    Possible values: non-empty and <= 200 characters

    authMethodType string

    Possible values: [API_AUTH_METHOD_TYPE_BASIC, API_AUTH_METHOD_TYPE_PRIVATE_KEY_JWT]

    Default value: API_AUTH_METHOD_TYPE_BASIC

Responses​

A successful response.

Schema

    appId string

    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 (string)
    clientId string

    generated secret for this config

    clientSecret string

    generated secret for this config

Loading...