Create Application (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.
Path Parameters
- projectId string required
Header Parameters
- x-zitadel-orgid stringThe 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. 
- application/json
- application/grpc
- application/grpc-web+proto
Request Body required
- name string requiredPossible values: non-emptyand<= 200 characters
- authMethodType stringPossible values: [ API_AUTH_METHOD_TYPE_BASIC,API_AUTH_METHOD_TYPE_PRIVATE_KEY_JWT]Default value: API_AUTH_METHOD_TYPE_BASIC
Request Body required
- name string requiredPossible values: non-emptyand<= 200 characters
- authMethodType stringPossible values: [ API_AUTH_METHOD_TYPE_BASIC,API_AUTH_METHOD_TYPE_PRIVATE_KEY_JWT]Default value: API_AUTH_METHOD_TYPE_BASIC
Request Body required
- name string requiredPossible values: non-emptyand<= 200 characters
- authMethodType stringPossible values: [ API_AUTH_METHOD_TYPE_BASIC,API_AUTH_METHOD_TYPE_PRIVATE_KEY_JWT]Default value: API_AUTH_METHOD_TYPE_BASIC
- 200
- default
A successful response.
- application/json
- application/grpc
- application/grpc-web+proto
- Schema
- Example (from schema)
Schema
- appId string
- details objectsequence 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
- clientId stringgenerated secret for this config 
- clientSecret stringgenerated secret for this config 
{
  "appId": "string",
  "details": {
    "sequence": "2",
    "creationDate": "2023-05-15",
    "changeDate": "2023-05-15",
    "resourceOwner": "69629023906488334"
  },
  "clientId": "3950723409029374",
  "clientSecret": "gjoq34589uasgh"
}
- Schema
- Example (from schema)
Schema
- appId string
- details objectsequence 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
- clientId stringgenerated secret for this config 
- clientSecret stringgenerated secret for this config 
{
  "appId": "string",
  "details": {
    "sequence": "2",
    "creationDate": "2023-05-15",
    "changeDate": "2023-05-15",
    "resourceOwner": "69629023906488334"
  },
  "clientId": "3950723409029374",
  "clientSecret": "gjoq34589uasgh"
}
- Schema
- Example (from schema)
Schema
- appId string
- details objectsequence 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
- clientId stringgenerated secret for this config 
- clientSecret stringgenerated secret for this config 
{
  "appId": "string",
  "details": {
    "sequence": "2",
    "creationDate": "2023-05-15",
    "changeDate": "2023-05-15",
    "resourceOwner": "69629023906488334"
  },
  "clientId": "3950723409029374",
  "clientSecret": "gjoq34589uasgh"
}
An unexpected error response.
- application/json
- application/grpc
- application/grpc-web+proto
- Schema
- Example (from schema)
Schema
- code int32
- message string
- details object[]Array [@type string]
{
  "code": 0,
  "message": "string",
  "details": [
    {
      "@type": "string"
    }
  ]
}
- Schema
- Example (from schema)
Schema
- code int32
- message string
- details object[]Array [@type string]
{
  "code": 0,
  "message": "string",
  "details": [
    {
      "@type": "string"
    }
  ]
}
- Schema
- Example (from schema)
Schema
- code int32
- message string
- details object[]Array [@type string]
{
  "code": 0,
  "message": "string",
  "details": [
    {
      "@type": "string"
    }
  ]
}