# Generate client secret (Apple)

Operation ID: `connectors.appleAuthGenerateClientSecret`

Generate client secret via Apple. Returns a string.

## Public method

`generateClientSecret`

Signature: `connectors.appleAuth.createClient(config).generateClientSecret(body)`

Return type: `Promise<AppleAuthGenerateClientSecretResult>`

## Authentication

Classification: **AUTHENTICATED**

Schemes: `bearerAuth`

## Prerequisites

None documented.

## HTTP

`POST /connectors/apple-auth/generate-client-secret`

## Path parameters

None.

## Query parameters

None.

## Body parameters

| Name | Type | Required | Format | Allowed values | Default | Nullable | Description |
|---|---|---:|---|---|---|---:|---|
| `body` | [`AppleAuthGenerateClientSecretRequest`](../models/AppleAuthGenerateClientSecretRequest.md) | Yes |  |  |  | No |  |

Request model: [`AppleAuthGenerateClientSecretRequest`](../models/AppleAuthGenerateClientSecretRequest.md)

## Request example

```json
{
  "client_id": "com.healthcheck.patient.web",
  "key_id": "J48237R89F",
  "mode": "live",
  "private_key": "example-api-key",
  "redirect_uri": "https://qfjfy6zc3e.execute-api.us-west-1.amazonaws.com/Prod/api/patient/auth/apple/callback",
  "team_id": "245UQW672V"
}
```

## Success responses

| Status | Shape | Content type | Description |
|---|---|---|---|
| `200` | [`AppleAuthGenerateClientSecretResponse`](../models/AppleAuthGenerateClientSecretResponse.md) | application/json | Successful response |

## Success response examples

### 200

```json
"example-credential"
```

## Common errors

| Status | Shape | Content type | Description |
|---|---|---|---|
| `400` | [`StandardErrorResponse`](../models/StandardErrorResponse.md) | application/json | Connector validation rejected the payload, or a required field was missing or of the wrong type. |
| `401` | [`StandardErrorResponse`](../models/StandardErrorResponse.md) | application/json | The HealthCloud bearer token is missing or invalid, or the vendor rejected the supplied connector credentials. |
| `500` | [`StandardErrorResponse`](../models/StandardErrorResponse.md) | application/json | The connector failed unexpectedly. |
| `502` | [`StandardErrorResponse`](../models/StandardErrorResponse.md) | application/json | The vendor returned an application or transport-level failure. |
| `504` | [`StandardErrorResponse`](../models/StandardErrorResponse.md) | application/json | The vendor did not respond within the connector timeout. |

## Error examples

### 400 — Invalid request

```json
{
  "error": "Invalid request"
}
```

### 401 — Authorization required

```json
{
  "error": "Authorization required"
}
```

### 500 — Internal error

```json
{
  "error": "Internal error"
}
```

### 502 — Upstream vendor error

```json
{
  "error": "Upstream vendor error"
}
```

### 504 — Upstream timeout

```json
{
  "error": "Upstream timeout"
}
```

## NodeJS / TypeScript implementation

```ts
import { HCSDK } from "@healthcloudai/hc-sdk";
import type { AppleAuthGenerateClientSecretRequest } from "@healthcloudai/hc-sdk";
```

```ts
const body = {
  "client_id": "com.healthcheck.patient.web",
  "key_id": "J48237R89F",
  "mode": "live",
  "private_key": "example-api-key",
  "redirect_uri": "https://qfjfy6zc3e.execute-api.us-west-1.amazonaws.com/Prod/api/patient/auth/apple/callback",
  "team_id": "245UQW672V"
};

const result = await connectors.appleAuth.createClient(config).generateClientSecret(body);
```

## cURL

```bash
curl -X POST \
  -H 'Authorization: Bearer <ACCESS_TOKEN>' \
  -H 'Content-Type: application/json' \
  -d '{"client_id":"com.healthcheck.patient.web","key_id":"J48237R89F","mode":"live","private_key":"example-api-key","redirect_uri":"https://qfjfy6zc3e.execute-api.us-west-1.amazonaws.com/Prod/api/patient/auth/apple/callback","team_id":"245UQW672V"}' \
  'https://dev-api-connectors.health.cloud/connectors/apple-auth/generate-client-secret'
```

## Notes

None.

## Prepared Test Console scenario

No canonical scenario is currently associated.

## Real response

No approved real integration response is currently published. Unapproved candidates are never rendered as examples.