CIPP icon

CIPP

CIPP-API is an Azure Function App providing the logic layer for the CIPP platform. This spec is auto-generated via static analysis of both the API (PowerShell) and frontend (React/Next.js) repositories. Last generated: 2026-03-02.

Actions75

TenantAdministration → SetAuthMethod

AI-generated

Overview

This node interacts with the CIPP API to set the authentication method for a tenant within the Tenant Administration resource. It is useful for managing tenant authentication settings programmatically, such as updating group IDs, state, or other related properties for a tenant's authentication method. For example, an administrator can automate the process of changing authentication methods across multiple tenants in a multi-tenant environment.

Use Case Examples

  1. Automate updating the authentication method for a specific tenant by specifying the tenant filter and relevant fields like Group IDs and state.
  2. Batch update authentication methods for multiple tenants with controlled request intervals to avoid rate limiting.

Properties

Name Meaning
Tenant Filter The tenant filter used to specify the target tenant for the authentication method update.
Group Ids Optional group IDs associated with the authentication method.
Id Optional identifier for the authentication method setting.
State Optional state value for the authentication method.

Output

JSON

  • debug - Debug information including actual URL, query parameters, headers, and body sent for each API request (if debug option is enabled).
  • response - The response from the API call to set the authentication method.

Dependencies

  • CIPP API with appropriate credentials

Troubleshooting

  • Ensure the tenant filter is correctly specified and matches an existing tenant.
  • Verify that the API credentials are valid and have permissions to modify tenant authentication settings.
  • If the request fails, enable the debug option to get detailed request and response information for troubleshooting.

Discussion