# Organizations ## List organizations the user has access to `client.organizations.list(OrganizationListParamsquery?, RequestOptionsoptions?): SinglePage` **get** `/organizations` Retrieve a list of organizations a particular user has access to. (Currently in Closed Beta - see https://developers.cloudflare.com/fundamentals/organizations/) ### Parameters - `query: OrganizationListParams` - `id?: Array` Only return organizations with the specified IDs (ex. id=foo&id=bar). Send multiple elements by repeating the query value. - `containing?: Containing` - `account?: string` Filter the list of organizations to the ones that contain this particular account. - `organization?: string` Filter the list of organizations to the ones that contain this particular organization. - `user?: string` Filter the list of organizations to the ones that contain this particular user. IMPORTANT: Just because an organization "contains" a user is not a representation of any authorization or privilege to manage any resources therein. An organization "containing" a user simply means the user is managed by that organization. - `name?: Name` - `contains?: string` (case-insensitive) Filter the list of organizations to where the name contains a particular string. - `endsWith?: string` (case-insensitive) Filter the list of organizations to where the name ends with a particular string. - `startsWith?: string` (case-insensitive) Filter the list of organizations to where the name starts with a particular string. - `page_size?: number` The amount of items to return. Defaults to 10. - `page_token?: string` An opaque token returned from the last list response that when provided will retrieve the next page. Parameters used to filter the retrieved list must remain in subsequent requests with a page token. - `parent?: Parent` - `id?: (string & {}) | "null"` Filter the list of organizations to the ones that are a sub-organization of the specified organization. "null" is a valid value to provide for this parameter. It means "where an organization has no parent (i.e. it is a 'root' organization)." - `(string & {})` - `"null"` - `"null"` ### Returns - `Organization` References an Organization in the Cloudflare data model. - `id: string` - `create_time: string` - `meta: Meta` - `flags?: Flags` Enable features for Organizations. - `account_creation: string` - `account_deletion: string` - `account_migration: string` - `account_mobility: string` - `sub_org_creation: string` - `managed_by?: string` - `name: string` - `parent?: Parent` - `id: string` - `name: string` - `profile?: Profile` - `business_address: string` - `business_email: string` - `business_name: string` - `business_phone: string` - `external_metadata: string` ### Example ```node import Cloudflare from 'cloudflare'; const client = new Cloudflare({ apiEmail: process.env['CLOUDFLARE_EMAIL'], // This is the default and can be omitted apiKey: process.env['CLOUDFLARE_API_KEY'], // This is the default and can be omitted }); // Automatically fetches more pages as needed. for await (const organization of client.organizations.list()) { console.log(organization.id); } ``` #### Response ```json { "errors": [], "messages": [ { "code": 1000, "message": "message", "documentation_url": "documentation_url", "source": { "pointer": "pointer" } } ], "result": [ { "id": "a7b9c3d2e8f4g1h5i6j0k9l2m3n7o4p8", "create_time": "2019-12-27T18:11:19.117Z", "meta": { "flags": { "account_creation": "account_creation", "account_deletion": "account_deletion", "account_migration": "account_migration", "account_mobility": "account_mobility", "sub_org_creation": "sub_org_creation" }, "managed_by": "managed_by" }, "name": "name", "parent": { "id": "a7b9c3d2e8f4g1h5i6j0k9l2m3n7o4p8", "name": "name" }, "profile": { "business_address": "business_address", "business_email": "business_email", "business_name": "business_name", "business_phone": "business_phone", "external_metadata": "external_metadata" } } ], "result_info": { "next_page_token": "next_page_token", "total_size": 0 }, "success": true } ``` ## Get organization `client.organizations.get(stringorganizationId, RequestOptionsoptions?): Organization` **get** `/organizations/{organization_id}` Retrieve the details of a certain organization. (Currently in Closed Beta - see https://developers.cloudflare.com/fundamentals/organizations/) ### Parameters - `organizationId: string` ### Returns - `Organization` References an Organization in the Cloudflare data model. - `id: string` - `create_time: string` - `meta: Meta` - `flags?: Flags` Enable features for Organizations. - `account_creation: string` - `account_deletion: string` - `account_migration: string` - `account_mobility: string` - `sub_org_creation: string` - `managed_by?: string` - `name: string` - `parent?: Parent` - `id: string` - `name: string` - `profile?: Profile` - `business_address: string` - `business_email: string` - `business_name: string` - `business_phone: string` - `external_metadata: string` ### Example ```node import Cloudflare from 'cloudflare'; const client = new Cloudflare({ apiEmail: process.env['CLOUDFLARE_EMAIL'], // This is the default and can be omitted apiKey: process.env['CLOUDFLARE_API_KEY'], // This is the default and can be omitted }); const organization = await client.organizations.get('a7b9c3d2e8f4g1h5i6j0k9l2m3n7o4p8'); console.log(organization.id); ``` #### Response ```json { "errors": [], "messages": [ { "code": 1000, "message": "message", "documentation_url": "documentation_url", "source": { "pointer": "pointer" } } ], "result": { "id": "a7b9c3d2e8f4g1h5i6j0k9l2m3n7o4p8", "create_time": "2019-12-27T18:11:19.117Z", "meta": { "flags": { "account_creation": "account_creation", "account_deletion": "account_deletion", "account_migration": "account_migration", "account_mobility": "account_mobility", "sub_org_creation": "sub_org_creation" }, "managed_by": "managed_by" }, "name": "name", "parent": { "id": "a7b9c3d2e8f4g1h5i6j0k9l2m3n7o4p8", "name": "name" }, "profile": { "business_address": "business_address", "business_email": "business_email", "business_name": "business_name", "business_phone": "business_phone", "external_metadata": "external_metadata" } }, "success": true } ``` ## Create organization `client.organizations.create(OrganizationCreateParamsbody, RequestOptionsoptions?): Organization` **post** `/organizations` Create a new organization for a user. (Currently in Closed Beta - see https://developers.cloudflare.com/fundamentals/organizations/) ### Parameters - `body: OrganizationCreateParams` - `name: string` - `parent?: Parent` - `id: string` - `name: string` - `profile?: Profile` - `business_address: string` - `business_email: string` - `business_name: string` - `business_phone: string` - `external_metadata: string` ### Returns - `Organization` References an Organization in the Cloudflare data model. - `id: string` - `create_time: string` - `meta: Meta` - `flags?: Flags` Enable features for Organizations. - `account_creation: string` - `account_deletion: string` - `account_migration: string` - `account_mobility: string` - `sub_org_creation: string` - `managed_by?: string` - `name: string` - `parent?: Parent` - `id: string` - `name: string` - `profile?: Profile` - `business_address: string` - `business_email: string` - `business_name: string` - `business_phone: string` - `external_metadata: string` ### Example ```node import Cloudflare from 'cloudflare'; const client = new Cloudflare({ apiEmail: process.env['CLOUDFLARE_EMAIL'], // This is the default and can be omitted apiKey: process.env['CLOUDFLARE_API_KEY'], // This is the default and can be omitted }); const organization = await client.organizations.create({ name: 'name' }); console.log(organization.id); ``` #### Response ```json { "errors": [], "messages": [ { "code": 1000, "message": "message", "documentation_url": "documentation_url", "source": { "pointer": "pointer" } } ], "result": { "id": "a7b9c3d2e8f4g1h5i6j0k9l2m3n7o4p8", "create_time": "2019-12-27T18:11:19.117Z", "meta": { "flags": { "account_creation": "account_creation", "account_deletion": "account_deletion", "account_migration": "account_migration", "account_mobility": "account_mobility", "sub_org_creation": "sub_org_creation" }, "managed_by": "managed_by" }, "name": "name", "parent": { "id": "a7b9c3d2e8f4g1h5i6j0k9l2m3n7o4p8", "name": "name" }, "profile": { "business_address": "business_address", "business_email": "business_email", "business_name": "business_name", "business_phone": "business_phone", "external_metadata": "external_metadata" } }, "success": true } ``` ## Modify organization. `client.organizations.update(stringorganizationId, OrganizationUpdateParamsbody, RequestOptionsoptions?): Organization` **put** `/organizations/{organization_id}` Modify organization. (Currently in Closed Beta - see https://developers.cloudflare.com/fundamentals/organizations/) ### Parameters - `organizationId: string` - `body: OrganizationUpdateParams` - `name: string` - `parent?: Parent` - `id: string` - `name: string` - `profile?: Profile` - `business_address: string` - `business_email: string` - `business_name: string` - `business_phone: string` - `external_metadata: string` ### Returns - `Organization` References an Organization in the Cloudflare data model. - `id: string` - `create_time: string` - `meta: Meta` - `flags?: Flags` Enable features for Organizations. - `account_creation: string` - `account_deletion: string` - `account_migration: string` - `account_mobility: string` - `sub_org_creation: string` - `managed_by?: string` - `name: string` - `parent?: Parent` - `id: string` - `name: string` - `profile?: Profile` - `business_address: string` - `business_email: string` - `business_name: string` - `business_phone: string` - `external_metadata: string` ### Example ```node import Cloudflare from 'cloudflare'; const client = new Cloudflare({ apiEmail: process.env['CLOUDFLARE_EMAIL'], // This is the default and can be omitted apiKey: process.env['CLOUDFLARE_API_KEY'], // This is the default and can be omitted }); const organization = await client.organizations.update('a7b9c3d2e8f4g1h5i6j0k9l2m3n7o4p8', { name: 'name', }); console.log(organization.id); ``` #### Response ```json { "errors": [], "messages": [ { "code": 1000, "message": "message", "documentation_url": "documentation_url", "source": { "pointer": "pointer" } } ], "result": { "id": "a7b9c3d2e8f4g1h5i6j0k9l2m3n7o4p8", "create_time": "2019-12-27T18:11:19.117Z", "meta": { "flags": { "account_creation": "account_creation", "account_deletion": "account_deletion", "account_migration": "account_migration", "account_mobility": "account_mobility", "sub_org_creation": "sub_org_creation" }, "managed_by": "managed_by" }, "name": "name", "parent": { "id": "a7b9c3d2e8f4g1h5i6j0k9l2m3n7o4p8", "name": "name" }, "profile": { "business_address": "business_address", "business_email": "business_email", "business_name": "business_name", "business_phone": "business_phone", "external_metadata": "external_metadata" } }, "success": true } ``` ## Delete organization. `client.organizations.delete(stringorganizationId, RequestOptionsoptions?): OrganizationDeleteResponse` **delete** `/organizations/{organization_id}` Delete an organization. The organization MUST be empty before deleting. It must not contain any sub-organizations, accounts, members or users. (Currently in Closed Beta - see https://developers.cloudflare.com/fundamentals/organizations/) ### Parameters - `organizationId: string` ### Returns - `OrganizationDeleteResponse` - `id: string` ### Example ```node import Cloudflare from 'cloudflare'; const client = new Cloudflare({ apiEmail: process.env['CLOUDFLARE_EMAIL'], // This is the default and can be omitted apiKey: process.env['CLOUDFLARE_API_KEY'], // This is the default and can be omitted }); const organization = await client.organizations.delete('a7b9c3d2e8f4g1h5i6j0k9l2m3n7o4p8'); console.log(organization.id); ``` #### Response ```json { "errors": [], "messages": [ { "code": 1000, "message": "message", "documentation_url": "documentation_url", "source": { "pointer": "pointer" } } ], "result": { "id": "id" }, "success": true } ``` ## Domain Types ### Organization - `Organization` References an Organization in the Cloudflare data model. - `id: string` - `create_time: string` - `meta: Meta` - `flags?: Flags` Enable features for Organizations. - `account_creation: string` - `account_deletion: string` - `account_migration: string` - `account_mobility: string` - `sub_org_creation: string` - `managed_by?: string` - `name: string` - `parent?: Parent` - `id: string` - `name: string` - `profile?: Profile` - `business_address: string` - `business_email: string` - `business_name: string` - `business_phone: string` - `external_metadata: string` ### Organization Delete Response - `OrganizationDeleteResponse` - `id: string` # Organization Accounts # Organization Profile ## Get organization profile `client.organizations.organizationProfile.get(stringorganizationId, RequestOptionsoptions?): Result` **get** `/organizations/{organization_id}/profile` Get an organizations profile if it exists. (Currently in Closed Beta - see https://developers.cloudflare.com/fundamentals/organizations/) ### Parameters - `organizationId: string` ### Returns - `Result` - `business_address: string` - `business_email: string` - `business_name: string` - `business_phone: string` - `external_metadata: string` ### Example ```node import Cloudflare from 'cloudflare'; const client = new Cloudflare({ apiEmail: process.env['CLOUDFLARE_EMAIL'], // This is the default and can be omitted apiKey: process.env['CLOUDFLARE_API_KEY'], // This is the default and can be omitted }); const organizationProfile = await client.organizations.organizationProfile.get( 'a7b9c3d2e8f4g1h5i6j0k9l2m3n7o4p8', ); console.log(organizationProfile.business_address); ``` #### Response ```json { "errors": [], "messages": [ { "code": 1000, "message": "message", "documentation_url": "documentation_url", "source": { "pointer": "pointer" } } ], "result": { "business_address": "business_address", "business_email": "business_email", "business_name": "business_name", "business_phone": "business_phone", "external_metadata": "external_metadata" }, "success": true } ``` ## Modify organization profile. `client.organizations.organizationProfile.update(stringorganizationId, OrganizationProfileUpdateParamsbody, RequestOptionsoptions?): void` **put** `/organizations/{organization_id}/profile` Modify organization profile. (Currently in Closed Beta - see https://developers.cloudflare.com/fundamentals/organizations/) ### Parameters - `organizationId: string` - `body: OrganizationProfileUpdateParams` - `business_address: string` - `business_email: string` - `business_name: string` - `business_phone: string` - `external_metadata: string` ### Example ```node import Cloudflare from 'cloudflare'; const client = new Cloudflare({ apiEmail: process.env['CLOUDFLARE_EMAIL'], // This is the default and can be omitted apiKey: process.env['CLOUDFLARE_API_KEY'], // This is the default and can be omitted }); await client.organizations.organizationProfile.update('a7b9c3d2e8f4g1h5i6j0k9l2m3n7o4p8', { business_address: 'business_address', business_email: 'business_email', business_name: 'business_name', business_phone: 'business_phone', external_metadata: 'external_metadata', }); ``` ## Domain Types ### Organization Profile - `OrganizationProfile` - `business_address: string` - `business_email: string` - `business_name: string` - `business_phone: string` - `external_metadata: string` # Members # Logs # Audit ## Get organization audit logs (Version 2, Beta release) `client.organizations.logs.audit.list(stringorganizationId, AuditListParamsquery, RequestOptionsoptions?): CursorPaginationAfter` **get** `/organizations/{organization_id}/logs/audit` Gets a list of audit logs for an organization. ### Parameters - `organizationId: string` The unique id that identifies the organization. - `query: AuditListParams` - `before: string` Limits the returned results to logs older than the specified date. This can be a date string 2019-04-30 (interpreted in UTC) or an absolute timestamp that conforms to RFC3339. - `since: string` Limits the returned results to logs newer than the specified date. This can be a date string 2019-04-30 (interpreted in UTC) or an absolute timestamp that conforms to RFC3339. - `id?: ID` - `not?: Array` Filters out audit logs by their IDs. - `action_result?: ActionResult` - `not?: Array<"success" | "failure">` Filters out audit logs by whether the action was successful or not. - `"success"` - `"failure"` - `action_type?: ActionType` - `not?: Array<"create" | "delete" | "view" | "update">` Filters out audit logs by the action type. - `"create"` - `"delete"` - `"view"` - `"update"` - `actor_context?: ActorContext` - `not?: Array<"api_key" | "api_token" | "dash" | 2 more>` Filters out audit logs by the actor context. - `"api_key"` - `"api_token"` - `"dash"` - `"oauth"` - `"origin_ca_key"` - `actor_email?: ActorEmail` - `not?: Array` Filters out audit logs by the actor's email address. - `actor_id?: ActorID` - `not?: Array` Filters out audit logs by the actor's user ID. - `actor_ip_address?: ActorIPAddress` - `not?: Array` Filters out audit logs IP address where the action was initiated. - `actor_token_id?: ActorTokenID` - `not?: Array` Filters out audit logs by the API token ID when the actor context is an api_token or oauth. - `actor_token_name?: ActorTokenName` - `not?: Array` Filters out audit logs by the API token name when the actor context is an api_token or oauth. - `actor_type?: ActorType` - `not?: Array<"cloudflare_admin" | "system" | "user">` Filters out audit logs by the actor type. - `"cloudflare_admin"` - `"system"` - `"user"` - `cursor?: string` The cursor is an opaque token used to paginate through large sets of records. It indicates the position from which to continue when requesting the next set of records. A valid cursor value can be obtained from the cursor object in the result_info structure of a previous response. - `direction?: "desc" | "asc"` Sets sorting order. - `"desc"` - `"asc"` - `limit?: number` The number limits the objects to return. The cursor attribute may be used to iterate over the next batch of objects if there are more than the limit. - `raw_cf_ray_id?: RawCfRayID` - `not?: Array` Filters out audit logs by the response CF Ray ID. - `raw_method?: RawMethod` - `not?: Array` Filters out audit logs by the HTTP method for the API call. - `raw_status_code?: RawStatusCode` - `not?: Array` Filters out audit logs by the response status code that was returned. - `raw_uri?: RawURI` - `not?: Array` Filters out audit logs by the request URI. - `resource_id?: ResourceID` - `not?: Array` Filters out audit logs by the resource ID. - `resource_product?: ResourceProduct` - `not?: Array` Filters out audit logs by the Cloudflare product associated with the changed resource. - `resource_scope?: ResourceScope` - `not?: Array<"organizations">` Filters out audit logs by the resource scope, specifying whether the resource is associated with an organization. - `"organizations"` - `resource_type?: ResourceType` - `not?: Array` Filters out audit logs based on the unique type of resource changed by the action. ### Returns - `AuditListResponse` - `id?: string` A unique identifier for the audit log entry. - `action?: Action` Provides information about the action performed. - `description?: string` A short description of the action performed. - `result?: string` The result of the action, indicating success or failure. - `time?: string` A timestamp indicating when the action was logged. - `type?: string` A short string that describes the action that was performed. - `actor?: Actor` Provides details about the actor who performed the action. - `id?: string` The ID of the actor who performed the action. If a user performed the action, this will be their User ID. - `context?: "api_key" | "api_token" | "dash" | 2 more` - `"api_key"` - `"api_token"` - `"dash"` - `"oauth"` - `"origin_ca_key"` - `email?: string` The email of the actor who performed the action. - `ip_address?: string` The IP address of the request that performed the action. - `token_id?: string` The API token ID when the actor context is an api_token or oauth. - `token_name?: string` The API token name when the actor context is an api_token or oauth. - `type?: "cloudflare_admin" | "system" | "user"` The type of actor. - `"cloudflare_admin"` - `"system"` - `"user"` - `organization?: Organization` Contains organization related information. - `id?: string` A unique identifier for the organization. - `raw?: Raw` Provides raw information about the request and response. - `cf_ray_id?: string` The Cloudflare Ray ID for the request. - `method?: string` The HTTP method of the request. - `status_code?: number` The HTTP response status code returned by the API. - `uri?: string` The URI of the request. - `user_agent?: string` The client's user agent string sent with the request. - `resource?: Resource` Provides details about the affected resource. - `id?: string` The unique identifier for the affected resource. - `product?: string` The Cloudflare product associated with the resource. - `request?: unknown` - `response?: unknown` - `scope?: unknown` The scope of the resource. - `type?: string` The type of the resource. ### Example ```node import Cloudflare from 'cloudflare'; const client = new Cloudflare({ apiToken: process.env['CLOUDFLARE_API_TOKEN'], // This is the default and can be omitted }); // Automatically fetches more pages as needed. for await (const auditListResponse of client.organizations.logs.audit.list( 'a67e14daa5f8dceeb91fe5449ba496ef', { before: '2024-10-31', since: '2024-10-30' }, )) { console.log(auditListResponse.id); } ``` #### Response ```json { "errors": [ { "message": "message" } ], "result": [ { "id": "023e105f4ecef8ad9ca31a8372d0c353", "action": { "description": "Add Member", "result": "success", "time": "2024-04-26T17:31:07Z", "type": "create" }, "actor": { "id": "f6b5de0326bb5182b8a4840ee01ec774", "context": "dash", "email": "alice@example.com", "ip_address": "198.41.129.166", "token_id": "token_id", "token_name": "token_name", "type": "user" }, "organization": { "id": "019c4f65e7607d8c9f6f6b58aa3aff50" }, "raw": { "cf_ray_id": "8e9b1c60ef9e1c9a", "method": "POST", "status_code": 200, "uri": "/accounts/4bb334f7c94c4a29a045f03944f072e5/members", "user_agent": "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) Safari/605.1.15" }, "resource": { "id": "id", "product": "organizations", "request": {}, "response": {}, "scope": {}, "type": "type" } } ], "result_info": { "count": "1", "cursor": "ASqdKd7dKgxh-aZ8bm0mZos1BtW4BdEqifCzNkEeGRzi_5SN_-362Y8sF-C1TRn60_6rd3z2dIajf9EAPyQ_NmIeAMkacmaJPXipqvP7PLU4t72wyqBeJfjmjdE=" }, "success": true } ``` ## Domain Types ### Audit List Response - `AuditListResponse` - `id?: string` A unique identifier for the audit log entry. - `action?: Action` Provides information about the action performed. - `description?: string` A short description of the action performed. - `result?: string` The result of the action, indicating success or failure. - `time?: string` A timestamp indicating when the action was logged. - `type?: string` A short string that describes the action that was performed. - `actor?: Actor` Provides details about the actor who performed the action. - `id?: string` The ID of the actor who performed the action. If a user performed the action, this will be their User ID. - `context?: "api_key" | "api_token" | "dash" | 2 more` - `"api_key"` - `"api_token"` - `"dash"` - `"oauth"` - `"origin_ca_key"` - `email?: string` The email of the actor who performed the action. - `ip_address?: string` The IP address of the request that performed the action. - `token_id?: string` The API token ID when the actor context is an api_token or oauth. - `token_name?: string` The API token name when the actor context is an api_token or oauth. - `type?: "cloudflare_admin" | "system" | "user"` The type of actor. - `"cloudflare_admin"` - `"system"` - `"user"` - `organization?: Organization` Contains organization related information. - `id?: string` A unique identifier for the organization. - `raw?: Raw` Provides raw information about the request and response. - `cf_ray_id?: string` The Cloudflare Ray ID for the request. - `method?: string` The HTTP method of the request. - `status_code?: number` The HTTP response status code returned by the API. - `uri?: string` The URI of the request. - `user_agent?: string` The client's user agent string sent with the request. - `resource?: Resource` Provides details about the affected resource. - `id?: string` The unique identifier for the affected resource. - `product?: string` The Cloudflare product associated with the resource. - `request?: unknown` - `response?: unknown` - `scope?: unknown` The scope of the resource. - `type?: string` The type of the resource.