AppClient

POST /appClient
Generate a new Cognito APP client
You must authenticate using an access token with the Authorization:accessToken header to use this endpoint.
Body parameter
{
  "groupId": "string",
  "name": "string"
}

Parameters

NameInTypeRequiredDescription
bodybodyGroupAppClientInputtruenone

Responses

StatusMeaningDescriptionSchema
200OKSuccess responseGroupAppClient
400Bad RequestBad requestNone

PUT /appClient
Update the Cognito APP client
You must authenticate using an access token with the Authorization:accessToken header to use this endpoint.
Body parameter
{
  "name": "string",
  "newName": "string",
  "groupId": "string"
}

Parameters

NameInTypeRequiredDescription
bodybodyUpdateGroupAppClientInputtruenone

Responses

StatusMeaningDescriptionSchema
200OKSuccess responseUpdateGroupAppClientInput
400Bad RequestBad requestNone

DELETE /appClient
Delete the Cognito APP client
You must authenticate using an access token with the Authorization:accessToken header to use this endpoint.

Parameters

NameInTypeRequiredDescription
namequerystringtrueUnaConnect Group Id
appClientIdquerystringtrueThe APP Client id to provide

Responses

StatusMeaningDescriptionSchema
200OKSuccess responseDeleteGroupAppClient
400Bad RequestBad requestNone

Schemas

GroupAppClient

{
  "groupId": "string",
  "appClientId": "string",
  "secret": "string",
  "description": "string",
  "expiration": 0
}

NameTypeRequiredRestrictionsDescription
groupIdstringtruenonenone
appClientIdstringtruenonenone
secretstringtruenonenone
descriptionstringfalsenonenone
expirationintegerfalsenonenone

UpdateGroupAppClient

{
  "appClientId": "string",
  "secret": "string",
  "name": "string",
  "expiration": 0
}

NameTypeRequiredRestrictionsDescription
appClientIdstringtruenonenone
secretstringtruenonenone
namestringtruenonenone
expirationintegerfalsenonenone

DeleteGroupAppClient

{
  "name": "string",
  "appClientId": "string"
}

NameTypeRequiredRestrictionsDescription
namestringtruenonenone
appClientIdstringtruenonenone

GroupAppClientInput

{
  "groupId": "string",
  "name": "string"
}

NameTypeRequiredRestrictionsDescription
groupIdstringtruenonenone
namestringtruenonenone

UpdateGroupAppClientInput

{
  "name": "string",
  "newName": "string",
  "groupId": "string"
}

NameTypeRequiredRestrictionsDescription
namestringtruenonenone
newNamestringtruenonenone
groupIdstringtruenonenone

DeleteGroupAppClientInput

{
  "name": "string"
}

NameTypeRequiredRestrictionsDescription
namestringtruenonenone