Generate New API Client Secret

POST 
/projects/:projectId/apps/:appId/api_config/_generate_client_secret

Generates a new client secret for the API application, make sure to save the response

Request

Path Parameters

projectId stringrequired
appId 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.

application/json

Body

required

object

application/grpc

Body

required

object

application/grpc-web+proto

Body

required

object

Responses

200

A successful response.

application/json

Schema

Schema

clientSecret string

generated secret for the client

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)

Example (from schema)

{
  "clientSecret": "k3n0fnslei93nps9",
  "details": {
    "sequence": "2",
    "creationDate": "2024-11-15T21:46:16.285Z",
    "changeDate": "2024-11-15T21:46:16.285Z",
    "resourceOwner": "69629023906488334"
  }
}

application/grpc

Schema

Schema

clientSecret string

generated secret for the client

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)

Example (from schema)

{
  "clientSecret": "k3n0fnslei93nps9",
  "details": {
    "sequence": "2",
    "creationDate": "2024-11-15T21:46:16.286Z",
    "changeDate": "2024-11-15T21:46:16.286Z",
    "resourceOwner": "69629023906488334"
  }
}

application/grpc-web+proto

Schema

Schema

clientSecret string

generated secret for the client

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)

Example (from schema)

{
  "clientSecret": "k3n0fnslei93nps9",
  "details": {
    "sequence": "2",
    "creationDate": "2024-11-15T21:46:16.286Z",
    "changeDate": "2024-11-15T21:46:16.286Z",
    "resourceOwner": "69629023906488334"
  }
}

default

An unexpected error response.

application/json

Schema

Schema

code int32
message string

details

object[]

Array [

@type string

]

Example (from schema)

{
  "code": 0,
  "message": "string",
  "details": [
    {
      "@type": "string"
    }
  ]
}

application/grpc

Schema

Schema

code int32
message string

details

object[]

Array [

@type string

]

Example (from schema)

{
  "code": 0,
  "message": "string",
  "details": [
    {
      "@type": "string"
    }
  ]
}

application/grpc-web+proto

Schema

Schema

code int32
message string

details

object[]

Array [

@type string

]

Example (from schema)

{
  "code": 0,
  "message": "string",
  "details": [
    {
      "@type": "string"
    }
  ]
}

Loading...