<!--
{
  "availability" : [

  ],
  "documentType" : "symbol",
  "framework" : "CloudKitJS",
  "identifier" : "/documentation/CloudKitJS/CloudKit/configure",
  "metadataVersion" : "0.1.0",
  "role" : "Instance Method",
  "symbol" : {
    "kind" : "Instance Method",
    "modules" : [
      "CloudKit JS"
    ],
    "preciseIdentifier" : "instm/CloudKit/configure"
  },
  "title" : "configure"
}
-->

# configure

Configures CloudKit JS.

```
CloudKit configure(
	CloudKit.CloudKitConfig config
);
```

## Parameters

`config`

The properties to use to initialize CloudKit JS.

## Return Value

The configured CloudKit object.

## Discussion

For each container that you access, specify the container ID, API token, and environment.

```javascript
CloudKit.configure({
    containers: [{
        containerIdentifier: '[insert your container ID here]',
        apiTokenAuth: {
            apiToken: '[insert your API token and other authentication properties here]'
        },
        environment: 'development'
    }]
});
```

Other [`CloudKit.ContainerConfig`](/documentation/CloudKitJS/CloudKit.ContainerConfig).`apiTokenAuth` keys, such as the `persist` key, are optional. To keep the user signed in after closing and reopening the browser, set `persist` to `true`.

```javascript
CloudKit.configure({
    containers: [{
        // ...
        apiTokenAuth: {
            apiToken: '[insert your API token and other authentication properties here]',
            persist: true
        }
    }]
});
```

To customize the sign in and sign out buttons, add `signInButton` and `signOutButton` keys to the `auth` dictionary.

For more container and service configuration options, see [`CloudKit.CloudKitConfig`](/documentation/CloudKitJS/CloudKit.CloudKitConfig) in [CloudKit JS Data Types](/documentation/CloudKitJS/cloudkit-js-data-types).

---

Copyright &copy; 2026 Apple Inc. All rights reserved. | [Terms of Use](https://www.apple.com/legal/internet-services/terms/site.html) | [Privacy Policy](https://www.apple.com/privacy/privacy-policy)