Get App Client (Partner) info in Cognito

GET /admin/cognito/partner/{clientId}
Authorization

Path parameters

  • clientId string Required

Responses

  • 200
    Hide response attribute Show response attribute object
    • UserPoolClient object Required
      Hide UserPoolClient attributes Show UserPoolClient attributes object
      • UserPoolId string Required
      • ClientName string Required
      • ClientId string Required
      • ClientSecret string Required
      • LastModifiedDate string(date-time) Required
      • CreationDate string(date-time) Required
      • RefreshTokenValidity number Required
      • TokenValidityUnits object Required
      • ExplicitAuthFlows array[string] Required
      • AllowedOAuthFlows array[string] Required
      • AllowedOAuthScopes array[string] Required
      • AllowedOAuthFlowsUserPoolClient boolean Required
      • PreventUserExistenceErrors string Required
      • EnableTokenRevocation boolean Required
  • 400
    Hide response attributes Show response attributes object
    • message object Required
    • data object Required
  • 401
    Hide response attributes Show response attributes object
    • message object Required
    • data object Required
  • 422
    Hide response attributes Show response attributes object
    • message object Required
    • data object Required
GET /admin/cognito/partner/{clientId} 
curl \
 -X GET https://open-api.hml.soupi.com.br/admin/cognito/partner/{clientId} \
 -H "Authorization: $API_KEY"
Response examples (200) 
{
  "UserPoolClient": {
    "UserPoolId": "string",
    "ClientName": "string",
    "ClientId": "string",
    "ClientSecret": "string",
    "LastModifiedDate": "2023-05-04T09:42:00+00:00",
    "CreationDate": "2023-05-04T09:42:00+00:00",
    "RefreshTokenValidity": 42.0,
    "TokenValidityUnits": {},
    "ExplicitAuthFlows": [
      "string"
    ],
    "AllowedOAuthFlows": [
      "string"
    ],
    "AllowedOAuthScopes": [
      "string"
    ],
    "AllowedOAuthFlowsUserPoolClient": true,
    "PreventUserExistenceErrors": "string",
    "EnableTokenRevocation": true
  }
}
Response examples (200) 
{
  "UserPoolClient": {
    "UserPoolId": "string",
    "ClientName": "string",
    "ClientId": "string",
    "ClientSecret": "string",
    "LastModifiedDate": "2025-05-04T09:42:00Z",
    "CreationDate": "2025-05-04T09:42:00Z",
    "RefreshTokenValidity": 42.0,
    "TokenValidityUnits": {},
    "ExplicitAuthFlows": [
      "string"
    ],
    "AllowedOAuthFlows": [
      "string"
    ],
    "AllowedOAuthScopes": [
      "string"
    ],
    "AllowedOAuthFlowsUserPoolClient": true,
    "PreventUserExistenceErrors": "string",
    "EnableTokenRevocation": true
  }
}
Response examples (400) 
{
  "message": {},
  "data": {}
}
Response examples (400) 
{
  "message": {},
  "data": {}
}
Response examples (401) 
{
  "message": {},
  "data": {}
}
Response examples (401) 
{
  "message": {},
  "data": {}
}
Response examples (422) 
{
  "message": {},
  "data": {}
}
Response examples (422) 
{
  "message": {},
  "data": {}
}