cloudflare
Version:
The official TypeScript library for the Cloudflare API
199 lines • 8.08 kB
JavaScript
// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
import { APIResource } from "../../../core/resource.mjs";
import * as SAMLCertificateAPI from "./saml-certificate.mjs";
import { BaseSAMLCertificate, SAMLCertificate, } from "./saml-certificate.mjs";
import * as SCIMAPI from "./scim/scim.mjs";
import { BaseSCIM, SCIM } from "./scim/scim.mjs";
import { CloudflareError } from "../../../core/error.mjs";
import { V4PagePaginationArray, } from "../../../core/pagination.mjs";
import { path } from "../../../internal/utils/path.mjs";
export var BaseIdentityProviders = /* @__PURE__ */ (() => {
class BaseIdentityProviders extends APIResource {
/**
* Adds a new identity provider to Access.
*
* @example
* ```ts
* const identityProvider =
* await client.zeroTrust.identityProviders.create({
* config: {},
* name: 'Widget Corps IDP',
* type: 'onetimepin',
* account_id: 'account_id',
* });
* ```
*/
create(params, options) {
const { account_id, zone_id, ...body } = params;
if (!account_id && !zone_id) {
throw new CloudflareError('You must provide either account_id or zone_id.');
}
if (account_id && zone_id) {
throw new CloudflareError('You cannot provide both account_id and zone_id.');
}
const { accountOrZone, accountOrZoneId } = account_id ?
{
accountOrZone: 'accounts',
accountOrZoneId: account_id,
}
: {
accountOrZone: 'zones',
accountOrZoneId: zone_id,
};
return this._client.post(path `/${accountOrZone}/${accountOrZoneId}/access/identity_providers`, {
body,
...options,
})._thenUnwrap((obj) => obj.result);
}
/**
* Updates a configured identity provider.
*
* @example
* ```ts
* const identityProvider =
* await client.zeroTrust.identityProviders.update(
* 'f174e90a-fafe-4643-bbbc-4a0ed4fc8415',
* {
* config: {},
* name: 'Widget Corps IDP',
* type: 'onetimepin',
* account_id: 'account_id',
* },
* );
* ```
*/
update(identityProviderID, params, options) {
const { account_id, zone_id, ...body } = params;
if (!account_id && !zone_id) {
throw new CloudflareError('You must provide either account_id or zone_id.');
}
if (account_id && zone_id) {
throw new CloudflareError('You cannot provide both account_id and zone_id.');
}
const { accountOrZone, accountOrZoneId } = account_id ?
{
accountOrZone: 'accounts',
accountOrZoneId: account_id,
}
: {
accountOrZone: 'zones',
accountOrZoneId: zone_id,
};
return this._client.put(path `/${accountOrZone}/${accountOrZoneId}/access/identity_providers/${identityProviderID}`, { body, ...options })._thenUnwrap((obj) => obj.result);
}
/**
* Lists all configured identity providers.
*
* @example
* ```ts
* // Automatically fetches more pages as needed.
* for await (const identityProviderListResponse of client.zeroTrust.identityProviders.list(
* { account_id: 'account_id' },
* )) {
* // ...
* }
* ```
*/
list(params = {}, options) {
const { account_id, zone_id, ...query } = params ?? {};
if (!account_id && !zone_id) {
throw new CloudflareError('You must provide either account_id or zone_id.');
}
if (account_id && zone_id) {
throw new CloudflareError('You cannot provide both account_id and zone_id.');
}
const { accountOrZone, accountOrZoneId } = account_id ?
{
accountOrZone: 'accounts',
accountOrZoneId: account_id,
}
: {
accountOrZone: 'zones',
accountOrZoneId: zone_id,
};
return this._client.getAPIList(path `/${accountOrZone}/${accountOrZoneId}/access/identity_providers`, (V4PagePaginationArray), { query, ...options });
}
/**
* Deletes an identity provider from Access.
*
* @example
* ```ts
* const identityProvider =
* await client.zeroTrust.identityProviders.delete(
* 'f174e90a-fafe-4643-bbbc-4a0ed4fc8415',
* { account_id: 'account_id' },
* );
* ```
*/
delete(identityProviderID, params = {}, options) {
const { account_id, zone_id } = params ?? {};
if (!account_id && !zone_id) {
throw new CloudflareError('You must provide either account_id or zone_id.');
}
if (account_id && zone_id) {
throw new CloudflareError('You cannot provide both account_id and zone_id.');
}
const { accountOrZone, accountOrZoneId } = account_id ?
{
accountOrZone: 'accounts',
accountOrZoneId: account_id,
}
: {
accountOrZone: 'zones',
accountOrZoneId: zone_id,
};
return this._client.delete(path `/${accountOrZone}/${accountOrZoneId}/access/identity_providers/${identityProviderID}`, options)._thenUnwrap((obj) => obj.result);
}
/**
* Fetches a configured identity provider.
*
* @example
* ```ts
* const identityProvider =
* await client.zeroTrust.identityProviders.get(
* 'f174e90a-fafe-4643-bbbc-4a0ed4fc8415',
* { account_id: 'account_id' },
* );
* ```
*/
get(identityProviderID, params = {}, options) {
const { account_id, zone_id } = params ?? {};
if (!account_id && !zone_id) {
throw new CloudflareError('You must provide either account_id or zone_id.');
}
if (account_id && zone_id) {
throw new CloudflareError('You cannot provide both account_id and zone_id.');
}
const { accountOrZone, accountOrZoneId } = account_id ?
{
accountOrZone: 'accounts',
accountOrZoneId: account_id,
}
: {
accountOrZone: 'zones',
accountOrZoneId: zone_id,
};
return this._client.get(path `/${accountOrZone}/${accountOrZoneId}/access/identity_providers/${identityProviderID}`, options)._thenUnwrap((obj) => obj.result);
}
}
BaseIdentityProviders._key = Object.freeze([
'zeroTrust',
'identityProviders',
]);
return BaseIdentityProviders;
})();
export var IdentityProviders = /* @__PURE__ */ (() => {
class IdentityProviders extends BaseIdentityProviders {
constructor() {
super(...arguments);
this.scim = new SCIMAPI.SCIM(this._client);
this.samlCertificate = new SAMLCertificateAPI.SAMLCertificate(this._client);
}
}
IdentityProviders.SCIM = SCIM;
IdentityProviders.BaseSCIM = BaseSCIM;
IdentityProviders.SAMLCertificate = SAMLCertificate;
IdentityProviders.BaseSAMLCertificate = BaseSAMLCertificate;
return IdentityProviders;
})();
//# sourceMappingURL=identity-providers.mjs.map