150 lines
4.6 KiB
TypeScript
150 lines
4.6 KiB
TypeScript
/**
|
|
* <div class="provider" style={{backgroundColor: "#0082C9", display: "flex", justifyContent: "space-between", color: "#fff", padding: 16}}>
|
|
* <span>Built-in <b>Nextcloud</b> integration.</span>
|
|
* <a href="https://nextcloud.com">
|
|
* <img style={{display: "block"}} src="https://authjs.dev/img/providers/nextcloud.svg" height="48" width="48"/>
|
|
* </a>
|
|
* </div>
|
|
*
|
|
* @module providers/nextcloud
|
|
*/
|
|
import type { OAuthConfig, OAuthUserConfig } from "./index.js";
|
|
/**
|
|
* Represents the Nextcloud user profile data returned from the `/ocs/v1.php/cloud/users/`.
|
|
* @see [Check out the documentation for more details](https://docs.nextcloud.com/server/latest/admin_manual/configuration_user/instruction_set_for_users.html#get-data-of-a-single-user)
|
|
*/
|
|
export interface NextcloudProfile extends Record<string, any> {
|
|
/**
|
|
* The user's username.
|
|
* @example "frank"
|
|
*/
|
|
id: string;
|
|
/**
|
|
* The email address associated with the user.
|
|
* @example "frank@domain.tld"
|
|
*/
|
|
email: string | null;
|
|
/**
|
|
* The display name of the user.
|
|
* @example "Frank K."
|
|
*/
|
|
displayname: string;
|
|
/**
|
|
* The phone number of the user.
|
|
*/
|
|
phone: string;
|
|
/**
|
|
* The address of the user.
|
|
* @example "Foobar 12, 12345 Town"
|
|
*/
|
|
address: string;
|
|
/**
|
|
* The website URL of the user.
|
|
* @example "https://nextcloud.com"
|
|
*/
|
|
website: string;
|
|
/**
|
|
* The user's Twitter handle.
|
|
* @example "Nextcloud"
|
|
*/
|
|
twitter: string;
|
|
/**
|
|
* The user's Fediverse handle.
|
|
*/
|
|
fediverse: string;
|
|
/**
|
|
* The organization associated with the user.
|
|
*/
|
|
organisation: string;
|
|
/**
|
|
* The role or position of the user.
|
|
*/
|
|
role: string;
|
|
/**
|
|
* The headline or brief description of the user.
|
|
*/
|
|
headline: string;
|
|
/**
|
|
* The biography or detailed description of the user.
|
|
*/
|
|
biography: string;
|
|
/**
|
|
* An array of group names that the user belongs to.
|
|
* @example ["admin", "group1", "group2"]
|
|
*/
|
|
groups: string[];
|
|
/**
|
|
* The language preference of the user.
|
|
* @example "en"
|
|
*/
|
|
language: string;
|
|
/**
|
|
* The locale or language locale of the user.
|
|
* @example "en_US"
|
|
*/
|
|
locale: string;
|
|
/**
|
|
* Indicates whether the user account is enabled or disabled.
|
|
* @example true
|
|
*/
|
|
enabled: boolean;
|
|
/**
|
|
* The storage location of the user's files.
|
|
* @example "/path/to/nextcloud/data/frank"
|
|
*/
|
|
storageLocation: string;
|
|
}
|
|
/**
|
|
* Add Nextcloud login to your page.
|
|
*
|
|
* ### Setup
|
|
*
|
|
* #### Callback URL
|
|
* ```
|
|
* https://example.com/auth/callback/nextcloud
|
|
* ```
|
|
*
|
|
* #### Configuration
|
|
* ```ts
|
|
* import { Auth } from "@auth/core"
|
|
* import Nextcloud from "@auth/core/providers/nextcloud"
|
|
*
|
|
* const request = new Request(origin)
|
|
* const response = await Auth(request, {
|
|
* providers: [
|
|
* Nextcloud({ clientId: AUTH_NEXTCLOUD_ID, clientSecret: AUTH_NEXTCLOUD_SECRET, issuer: AUTH_NEXTCLOUD_ISSUER }),
|
|
* ],
|
|
* })
|
|
* ```
|
|
*
|
|
* ### Resources
|
|
*
|
|
* - [Nextcloud Documentation](https://docs.nextcloud.com/)
|
|
* - [Nextcloud OAuth 2](https://docs.nextcloud.com/server/latest/admin_manual/configuration_server/oauth2.html)
|
|
* - [Nextcloud Clients and Client APIs](https://docs.nextcloud.com/server/latest/developer_manual/client_apis/index.html)
|
|
* - [Nextcloud User provisioning API](https://docs.nextcloud.com/server/latest/admin_manual/configuration_user/user_provisioning_api.html)
|
|
*
|
|
* ### Notes
|
|
*
|
|
* By default, Auth.js assumes that the Nextcloud provider is
|
|
* based on the [OAuth 2](https://www.rfc-editor.org/rfc/rfc6749.html) specification.
|
|
*
|
|
* :::tip
|
|
*
|
|
* The Nextcloud provider comes with a [default configuration](https://github.com/nextauthjs/next-auth/blob/main/packages/core/src/providers/nextcloud.ts).
|
|
* To override the defaults for your use case, check out [customizing a built-in OAuth provider](https://authjs.dev/guides/configuring-oauth-providers).
|
|
*
|
|
* :::
|
|
*
|
|
* :::info **Disclaimer**
|
|
*
|
|
* If you think you found a bug in the default configuration, you can [open an issue](https://authjs.dev/new/provider-issue).
|
|
*
|
|
* Auth.js strictly adheres to the specification and it cannot take responsibility for any deviation from
|
|
* the spec by the provider. You can open an issue, but if the problem is non-compliance with the spec,
|
|
* we might not pursue a resolution. You can ask for more help in [Discussions](https://authjs.dev/new/github-discussions).
|
|
*
|
|
* :::
|
|
*/
|
|
export default function Nextcloud(options: OAuthUserConfig<NextcloudProfile>): OAuthConfig<NextcloudProfile>;
|
|
//# sourceMappingURL=nextcloud.d.ts.map
|