auth0
Version:
SDK for Auth0 API v2
514 lines • 19.8 kB
JavaScript
import * as runtime from '../../../lib/runtime.js';
const { BaseAPI } = runtime;
/**
*
*/
export class OrganizationsManager extends BaseAPI {
/**
* Remove a client grant from an organization
*
* @throws {RequiredError}
*/
async deleteClientGrantsByGrantId(requestParameters, initOverrides) {
runtime.validateRequiredRequestParams(requestParameters, ['id', 'grant_id']);
const response = await this.request({
path: `/organizations/{id}/client-grants/{grant_id}`
.replace('{id}', encodeURIComponent(String(requestParameters.id)))
.replace('{grant_id}', encodeURIComponent(String(requestParameters.grant_id))),
method: 'DELETE',
}, initOverrides);
return runtime.VoidApiResponse.fromResponse(response);
}
/**
* Delete connections from an organization
*
* @throws {RequiredError}
*/
async deleteEnabledConnection(requestParameters, initOverrides) {
runtime.validateRequiredRequestParams(requestParameters, ['id', 'connectionId']);
const response = await this.request({
path: `/organizations/{id}/enabled_connections/{connectionId}`
.replace('{id}', encodeURIComponent(String(requestParameters.id)))
.replace('{connectionId}', encodeURIComponent(String(requestParameters.connectionId))),
method: 'DELETE',
}, initOverrides);
return runtime.VoidApiResponse.fromResponse(response);
}
/**
* Delete an invitation to organization
*
* @throws {RequiredError}
*/
async deleteInvitation(requestParameters, initOverrides) {
runtime.validateRequiredRequestParams(requestParameters, ['id', 'invitation_id']);
const response = await this.request({
path: `/organizations/{id}/invitations/{invitation_id}`
.replace('{id}', encodeURIComponent(String(requestParameters.id)))
.replace('{invitation_id}', encodeURIComponent(String(requestParameters.invitation_id))),
method: 'DELETE',
}, initOverrides);
return runtime.VoidApiResponse.fromResponse(response);
}
/**
* Delete members from an organization
*
* @throws {RequiredError}
*/
async deleteMembers(requestParameters, bodyParameters, initOverrides) {
runtime.validateRequiredRequestParams(requestParameters, ['id']);
const headerParameters = {};
headerParameters['Content-Type'] = 'application/json';
const response = await this.request({
path: `/organizations/{id}/members`.replace('{id}', encodeURIComponent(String(requestParameters.id))),
method: 'DELETE',
headers: headerParameters,
body: bodyParameters,
}, initOverrides);
return runtime.VoidApiResponse.fromResponse(response);
}
/**
* Remove one or more roles from a given user in the context of the provided organization
*
* @throws {RequiredError}
*/
async deleteMemberRoles(requestParameters, bodyParameters, initOverrides) {
runtime.validateRequiredRequestParams(requestParameters, ['id', 'user_id']);
const headerParameters = {};
headerParameters['Content-Type'] = 'application/json';
const response = await this.request({
path: `/organizations/{id}/members/{user_id}/roles`
.replace('{id}', encodeURIComponent(String(requestParameters.id)))
.replace('{user_id}', encodeURIComponent(String(requestParameters.user_id))),
method: 'DELETE',
headers: headerParameters,
body: bodyParameters,
}, initOverrides);
return runtime.VoidApiResponse.fromResponse(response);
}
/**
* Delete a specific organization
*
* Delete organization
*
* @throws {RequiredError}
*/
async delete(requestParameters, initOverrides) {
runtime.validateRequiredRequestParams(requestParameters, ['id']);
const response = await this.request({
path: `/organizations/{id}`.replace('{id}', encodeURIComponent(String(requestParameters.id))),
method: 'DELETE',
}, initOverrides);
return runtime.VoidApiResponse.fromResponse(response);
}
async getEnabledConnections(requestParameters, initOverrides) {
runtime.validateRequiredRequestParams(requestParameters, ['id']);
const queryParameters = runtime.applyQueryParams(requestParameters, [
{
key: 'page',
config: {},
},
{
key: 'per_page',
config: {},
},
{
key: 'include_totals',
config: {},
},
]);
const response = await this.request({
path: `/organizations/{id}/enabled_connections`.replace('{id}', encodeURIComponent(String(requestParameters.id))),
method: 'GET',
query: queryParameters,
}, initOverrides);
return runtime.JSONApiResponse.fromResponse(response);
}
/**
* Get an enabled connection for an organization
*
* @throws {RequiredError}
*/
async getEnabledConnection(requestParameters, initOverrides) {
runtime.validateRequiredRequestParams(requestParameters, ['id', 'connectionId']);
const response = await this.request({
path: `/organizations/{id}/enabled_connections/{connectionId}`
.replace('{id}', encodeURIComponent(String(requestParameters.id)))
.replace('{connectionId}', encodeURIComponent(String(requestParameters.connectionId))),
method: 'GET',
}, initOverrides);
return runtime.JSONApiResponse.fromResponse(response);
}
async getInvitations(requestParameters, initOverrides) {
runtime.validateRequiredRequestParams(requestParameters, ['id']);
const queryParameters = runtime.applyQueryParams(requestParameters, [
{
key: 'page',
config: {},
},
{
key: 'per_page',
config: {},
},
{
key: 'include_totals',
config: {},
},
{
key: 'fields',
config: {},
},
{
key: 'include_fields',
config: {},
},
{
key: 'sort',
config: {},
},
]);
const response = await this.request({
path: `/organizations/{id}/invitations`.replace('{id}', encodeURIComponent(String(requestParameters.id))),
method: 'GET',
query: queryParameters,
}, initOverrides);
return runtime.JSONApiResponse.fromResponse(response);
}
/**
* Get an invitation to organization
*
* @throws {RequiredError}
*/
async getInvitation(requestParameters, initOverrides) {
runtime.validateRequiredRequestParams(requestParameters, ['id', 'invitation_id']);
const queryParameters = runtime.applyQueryParams(requestParameters, [
{
key: 'fields',
config: {},
},
{
key: 'include_fields',
config: {},
},
]);
const response = await this.request({
path: `/organizations/{id}/invitations/{invitation_id}`
.replace('{id}', encodeURIComponent(String(requestParameters.id)))
.replace('{invitation_id}', encodeURIComponent(String(requestParameters.invitation_id))),
method: 'GET',
query: queryParameters,
}, initOverrides);
return runtime.JSONApiResponse.fromResponse(response);
}
async getMembers(requestParameters, initOverrides) {
runtime.validateRequiredRequestParams(requestParameters, ['id']);
const queryParameters = runtime.applyQueryParams(requestParameters, [
{
key: 'page',
config: {},
},
{
key: 'per_page',
config: {},
},
{
key: 'include_totals',
config: {},
},
{
key: 'from',
config: {},
},
{
key: 'take',
config: {},
},
{
key: 'fields',
config: {},
},
{
key: 'include_fields',
config: {},
},
]);
const response = await this.request({
path: `/organizations/{id}/members`.replace('{id}', encodeURIComponent(String(requestParameters.id))),
method: 'GET',
query: queryParameters,
}, initOverrides);
return runtime.JSONApiResponse.fromResponse(response);
}
/**
* Retrieve details about a single Organization specified by name.
*
* Get organization by name
*
* @throws {RequiredError}
*/
async getByName(requestParameters, initOverrides) {
runtime.validateRequiredRequestParams(requestParameters, ['name']);
const response = await this.request({
path: `/organizations/name/{name}`.replace('{name}', encodeURIComponent(String(requestParameters.name))),
method: 'GET',
}, initOverrides);
return runtime.JSONApiResponse.fromResponse(response);
}
async getOrganizationClientGrants(requestParameters, initOverrides) {
runtime.validateRequiredRequestParams(requestParameters, ['id']);
const queryParameters = runtime.applyQueryParams(requestParameters, [
{
key: 'audience',
config: {},
},
{
key: 'client_id',
config: {},
},
{
key: 'grant_ids',
config: {
isArray: true,
isCollectionFormatMulti: true,
},
},
{
key: 'page',
config: {},
},
{
key: 'per_page',
config: {},
},
{
key: 'include_totals',
config: {},
},
]);
const response = await this.request({
path: `/organizations/{id}/client-grants`.replace('{id}', encodeURIComponent(String(requestParameters.id))),
method: 'GET',
query: queryParameters,
}, initOverrides);
return runtime.JSONApiResponse.fromResponse(response);
}
async getMemberRoles(requestParameters, initOverrides) {
runtime.validateRequiredRequestParams(requestParameters, ['id', 'user_id']);
const queryParameters = runtime.applyQueryParams(requestParameters, [
{
key: 'page',
config: {},
},
{
key: 'per_page',
config: {},
},
{
key: 'include_totals',
config: {},
},
]);
const response = await this.request({
path: `/organizations/{id}/members/{user_id}/roles`
.replace('{id}', encodeURIComponent(String(requestParameters.id)))
.replace('{user_id}', encodeURIComponent(String(requestParameters.user_id))),
method: 'GET',
query: queryParameters,
}, initOverrides);
return runtime.JSONApiResponse.fromResponse(response);
}
async getAll(requestParameters = {}, initOverrides) {
const queryParameters = runtime.applyQueryParams(requestParameters, [
{
key: 'page',
config: {},
},
{
key: 'per_page',
config: {},
},
{
key: 'include_totals',
config: {},
},
{
key: 'from',
config: {},
},
{
key: 'take',
config: {},
},
{
key: 'sort',
config: {},
},
]);
const response = await this.request({
path: `/organizations`,
method: 'GET',
query: queryParameters,
}, initOverrides);
return runtime.JSONApiResponse.fromResponse(response);
}
/**
* Retrieve details about a single Organization specified by ID.
*
* Get organization
*
* @throws {RequiredError}
*/
async get(requestParameters, initOverrides) {
runtime.validateRequiredRequestParams(requestParameters, ['id']);
const response = await this.request({
path: `/organizations/{id}`.replace('{id}', encodeURIComponent(String(requestParameters.id))),
method: 'GET',
}, initOverrides);
return runtime.JSONApiResponse.fromResponse(response);
}
/**
* Modify an enabled_connection belonging to an Organization.
*
* Modify an Organizations Connection
*
* @throws {RequiredError}
*/
async updateEnabledConnection(requestParameters, bodyParameters, initOverrides) {
runtime.validateRequiredRequestParams(requestParameters, ['id', 'connectionId']);
const headerParameters = {};
headerParameters['Content-Type'] = 'application/json';
const response = await this.request({
path: `/organizations/{id}/enabled_connections/{connectionId}`
.replace('{id}', encodeURIComponent(String(requestParameters.id)))
.replace('{connectionId}', encodeURIComponent(String(requestParameters.connectionId))),
method: 'PATCH',
headers: headerParameters,
body: bodyParameters,
}, initOverrides);
return runtime.JSONApiResponse.fromResponse(response);
}
/**
* Update the details of a specific <a href="https://auth0.com/docs/manage-users/organizations/configure-organizations/create-organizations">Organization</a>, such as name and display name, branding options, and metadata.
*
* Modify an Organization
*
* @throws {RequiredError}
*/
async update(requestParameters, bodyParameters, initOverrides) {
runtime.validateRequiredRequestParams(requestParameters, ['id']);
const headerParameters = {};
headerParameters['Content-Type'] = 'application/json';
const response = await this.request({
path: `/organizations/{id}`.replace('{id}', encodeURIComponent(String(requestParameters.id))),
method: 'PATCH',
headers: headerParameters,
body: bodyParameters,
}, initOverrides);
return runtime.JSONApiResponse.fromResponse(response);
}
/**
* Add connections to an organization
*
* @throws {RequiredError}
*/
async addEnabledConnection(requestParameters, bodyParameters, initOverrides) {
runtime.validateRequiredRequestParams(requestParameters, ['id']);
const headerParameters = {};
headerParameters['Content-Type'] = 'application/json';
const response = await this.request({
path: `/organizations/{id}/enabled_connections`.replace('{id}', encodeURIComponent(String(requestParameters.id))),
method: 'POST',
headers: headerParameters,
body: bodyParameters,
}, initOverrides);
return runtime.JSONApiResponse.fromResponse(response);
}
/**
* Create invitations to organization
*
* @throws {RequiredError}
*/
async createInvitation(requestParameters, bodyParameters, initOverrides) {
runtime.validateRequiredRequestParams(requestParameters, ['id']);
const headerParameters = {};
headerParameters['Content-Type'] = 'application/json';
const response = await this.request({
path: `/organizations/{id}/invitations`.replace('{id}', encodeURIComponent(String(requestParameters.id))),
method: 'POST',
headers: headerParameters,
body: bodyParameters,
}, initOverrides);
return runtime.JSONApiResponse.fromResponse(response);
}
/**
* Add members to an organization
*
* @throws {RequiredError}
*/
async addMembers(requestParameters, bodyParameters, initOverrides) {
runtime.validateRequiredRequestParams(requestParameters, ['id']);
const headerParameters = {};
headerParameters['Content-Type'] = 'application/json';
const response = await this.request({
path: `/organizations/{id}/members`.replace('{id}', encodeURIComponent(String(requestParameters.id))),
method: 'POST',
headers: headerParameters,
body: bodyParameters,
}, initOverrides);
return runtime.VoidApiResponse.fromResponse(response);
}
/**
* Associate a client grant with an organization
*
* @throws {RequiredError}
*/
async postOrganizationClientGrants(requestParameters, bodyParameters, initOverrides) {
runtime.validateRequiredRequestParams(requestParameters, ['id']);
const headerParameters = {};
headerParameters['Content-Type'] = 'application/json';
const response = await this.request({
path: `/organizations/{id}/client-grants`.replace('{id}', encodeURIComponent(String(requestParameters.id))),
method: 'POST',
headers: headerParameters,
body: bodyParameters,
}, initOverrides);
return runtime.JSONApiResponse.fromResponse(response);
}
/**
* Assign one or more roles to a given user that will be applied in the context of the provided organization
*
* @throws {RequiredError}
*/
async addMemberRoles(requestParameters, bodyParameters, initOverrides) {
runtime.validateRequiredRequestParams(requestParameters, ['id', 'user_id']);
const headerParameters = {};
headerParameters['Content-Type'] = 'application/json';
const response = await this.request({
path: `/organizations/{id}/members/{user_id}/roles`
.replace('{id}', encodeURIComponent(String(requestParameters.id)))
.replace('{user_id}', encodeURIComponent(String(requestParameters.user_id))),
method: 'POST',
headers: headerParameters,
body: bodyParameters,
}, initOverrides);
return runtime.VoidApiResponse.fromResponse(response);
}
/**
* Create a new Organization within your tenant. To learn more about Organization settings, behavior, and configuration options, review <a href="https://auth0.com/docs/manage-users/organizations/create-first-organization">Create Your First Organization</a>.
*
* Create an Organization
*
* @throws {RequiredError}
*/
async create(bodyParameters, initOverrides) {
const headerParameters = {};
headerParameters['Content-Type'] = 'application/json';
const response = await this.request({
path: `/organizations`,
method: 'POST',
headers: headerParameters,
body: bodyParameters,
}, initOverrides);
return runtime.JSONApiResponse.fromResponse(response);
}
}
//# sourceMappingURL=organizations-manager.js.map