The CloudRadial AutomationAI CIPP Identity extensions let a workflow or agent manage identity across your GDAP client tenants through your CIPP (CyberDrain Improved Partner Portal) instance: look up tenants, users, guests, groups, roles, MFA status, and sign-ins, run identity security reports, and, with approval, create and offboard users, reset passwords, change group membership, grant admin roles, and remediate a compromised account. This article covers the two versions of the extension, connecting them to your CIPP API client, which tools require approval, and the skills that ship with them. It is for workspace users who build automations (Admin or Owner Role).
The CIPP Identity extensions require a runner on version 2.6.0 or later. On an earlier runner, every CIPP call fails when it requests a sign-in token. A runner that updates itself automatically picks up 2.6.0 on its own; for an older runner, see Upgrading a runner to a new version.
- Choosing a Version
- What the Extensions Cover
- Connecting to Your CIPP API Client
- Providing the Credentials to Your Runner
- Limiting Access With CIPP Roles
- Reads and Approval-Gated Changes
- Passwords and Temporary Access Passes in Run Output
- Skills
- Tips for Working With CIPP
Choosing a Version
The extension comes in two versions in the catalog, both from vendor CyberDrain at version 1.0.0:
| Extension | Tools | Use it when |
|---|---|---|
| CIPP Identity | 78 tools: 34 reads and 44 approval-gated writes, in 7 skills | You want agents to report on identity and also make changes, such as resetting a password or offboarding a user, after someone approves each one |
| CIPP Identity (Read-Only) | The same 34 reads and no write tools, in 2 skills | You want agents to look up and report on identity, but never change anything |
Both versions use the same four secrets. Install one or the other, not both. They share tool names, so if you do need both in one workspace, scope each agent to only one of them. See Creating custom agents and using them in workflows.
Install either version from Extensions like any other catalog extension. See Browsing and installing extensions for the general install flow.
What the Extensions Cover
The extensions call your CIPP instance's API. CIPP reaches each client tenant through your GDAP relationships, so you do not consent an app in each client tenant. The tools cover these areas:
| Area | What you can read | What you can change (CIPP Identity only, with approval) |
|---|---|---|
| Tenants and users | Client tenants, users and guests, a user's groups, devices, mailbox details, inbox rules, sign-in logs, settings, OneDrive shortcuts, and photo, user counts, soft-deleted items, and new-user defaults | Create, edit, disable, offboard, restore, or delete users; add guests; change aliases, photo, licenses, hybrid sync settings, OneDrive, and devices |
| Groups | Groups, group usage, and who may send to a group | Create or edit groups, change membership now or for a set date range, and create a team for a group |
| Passwords and MFA | MFA registration and per-user MFA status | Reset a password, require a password change, revoke sessions, reset MFA, issue a Temporary Access Pass, change MFA methods, send a test MFA prompt, and set password expiry |
| Admin roles | Roles and role assignments, PIM roles, just-in-time (JIT) admins, JIT requests, and the roles JIT may grant | Grant JIT or PIM admin roles, approve or reject JIT requests, and remove admin roles |
| Security reports | Inactive accounts, basic authentication use, Azure AD Connect status, sign-ins, object change history, and stored business email compromise (BEC) runs | Run a BEC check, remediate a compromised account, review sign-in addresses, remove trusted senders, and dismiss a user's risk state |
The extensions do not include CIPP's internal templates (group, JIT, PIM, and user-default templates) or its PDF and evidence exports.
Connecting to Your CIPP API Client
The extensions sign in with OAuth client credentials. Entra ID issues the token for a CIPP API client, the integration CIPP provides at Integrations > CIPP-API in your CIPP instance (CIPP > Integrations, then CIPP-API). You need four values:
- The API URL and the Tenant ID, both shown on the CIPP-API integration page
- The API client's application ID
- The API client's secret. Copy it to a secure location when you create the client; if you lose it, use Reset Application Secret to issue a new one.
For how to create the API client in CIPP, see CyberDrain's CIPP API setup and authentication documentation.
Providing the Credentials to Your Runner
Store four secrets in your runner's Key Vault with these exact names. Both versions of the extension use the same secrets.
| Secret | Value |
|---|---|
CIPP-ApiUrl |
Your CIPP API URL from the CIPP-API integration page, without a trailing /api, for example https://cippxxxxx.azurewebsites.net
|
CIPP-TenantId |
The tenant ID shown on the CIPP-API integration page |
CIPP-ClientId |
The API client's application (client) ID |
CIPP-ClientSecret |
The API client's secret |
For how to add these, see Accessing and updating your runner's Key Vault. The agent reads the credentials from the runner and never asks you for them. Once the secrets are in place, ask the AI Playground to list your CIPP tenants to confirm the connection works.
Limiting Access With CIPP Roles
CIPP issues one kind of token for an API client, so the extension cannot ask for a narrower, read-only token. What an API client can do is set by the CIPP role assigned to it. Use a CIPP custom role on the API client to allow only what you need.
The read tools use these CIPP roles:
CIPP.Core.ReadExchange.Groups.ReadExchange.Mailbox.ReadIdentity.AuditLog.ReadIdentity.Group.ReadIdentity.Role.ReadIdentity.User.ReadTenant.Directory.Read
The write tools in CIPP Identity also use Exchange.Mailbox.ReadWrite, Identity.Device.ReadWrite, Identity.DirSync.ReadWrite, Identity.Group.ReadWrite, Identity.Role.ReadWrite, Identity.User.ReadWrite, and Tenant.Directory.ReadWrite.
If you install CIPP Identity (Read-Only), pair it with an API client whose custom role grants only the read roles above. The extension has no write tools, and the custom role makes CIPP enforce read-only as well.
Reads and Approval-Gated Changes
Of the 78 tools in CIPP Identity, 34 are read-only and run without interruption. The other 44 create, change, or delete something, and every one of them is approval-gated: the run pauses and the request appears as an Action Required item in the Inbox until someone approves it. See Handling Action Required items in the Inbox. All 34 tools in CIPP Identity (Read-Only) run without approval.
Before a write, the agent states the tenant, the user, and the change, so check all three before you approve. Take extra care with requests that:
- Offboard, disable, or delete a user, or permanently delete a soft-deleted item
- Reset a password, revoke sessions, reset MFA, or issue a Temporary Access Pass
- Grant or remove an admin role
- Run BEC remediation, which resets the password, revokes sessions, and disables inbox rules
- Send a test MFA prompt, which causes a real prompt on the user's device
Listing the available BEC remediation actions also asks for approval. CIPP treats that call as a write, so it is not in the read-only version.
Passwords and Temporary Access Passes in Run Output
Two tools return a credential:
- Resetting a password returns the new password, or a one-time link when CIPP's password push integration is turned on
- Issuing a Temporary Access Pass returns the pass in plain text unless the request asks CIPP for a password push link
The returned value is in the run's step output. The Reset a Password and Revoke Sessions skill tells the agent not to repeat a returned password, link, or pass in a ticket note or chat reply unless the workflow explicitly sends it to an approved recipient. When you build a workflow around these tools, decide where the credential should go, and limit who can read that workflow's run history.
Skills
CIPP Identity ships seven skills that guide an agent through common identity tasks. CIPP Identity (Read-Only) ships the two read-only skills, Find Tenants and Users and Identity Security Reports.
| Skill | Use it to |
|---|---|
| Find Tenants and Users | Resolve a client tenant and look up users, guests, groups, devices, mailbox details, inbox rules, and sign-ins. Read-only. |
| Identity Security Reports | Report on MFA coverage, inactive accounts, sign-ins, roles and JIT requests, basic authentication, Azure AD Connect status, change history, and stored BEC runs, for one tenant or all tenants. Read-only. |
| Create, Change, Disable and Offboard Users | Add, edit, disable, offboard, restore, or remove users, and change their aliases, photo, licenses, hybrid sync, OneDrive, and devices. Changes are approval-gated. |
| Manage Groups and Membership | List, create, or edit groups, change membership now or on a schedule, and create a team for a group. Changes are approval-gated. |
| Reset a Password and Revoke Sessions | Reset a user's password, revoke their sessions, and manage their MFA and Temporary Access Passes. The agent refuses admin, disabled, or unresolved accounts and says why. Changes are approval-gated. |
| Investigate a Compromised Account | Run CIPP's BEC check, review inbox rules, sign-ins, and phishing spread, remediate the account, and clean up afterward. Remediation and clean-up are approval-gated. |
| Manage Admin Roles | Grant just-in-time (JIT) or PIM admin roles, decide pending JIT requests, and remove admin roles. Changes are approval-gated. |
Tips for Working With CIPP
- Refer to client tenants by name and let the agent look them up. It searches your CIPP tenants rather than guessing a domain.
- To report across every client at once, ask for all tenants. The agent makes one estate-wide call from CIPP's cached report data instead of querying tenant by tenant.
- CIPP allows 100 requests per 10 seconds per API client, so prefer estate-wide reports over loops that call each tenant separately
- The tools are built from CIPP's published API description, which CyberDrain marks as inferred. Check the results the first time you use a write tool.
- After offboarding a user, ask for the offboarding progress to confirm each step finished
- A PIM role assignment needs Entra ID P2 in the client tenant, and every assignment must have an end date
- The credentials are the same for every client tenant, because CIPP reaches each one through GDAP. You do not need per-company credentials for these extensions.
- If every CIPP call fails at sign-in, check that your runner is on version 2.6.0 or later and that all four secrets are set with the exact names above. Also check that
CIPP-ApiUrldoes not end in/api.
If you are still having trouble, we’re here to help! Submit a ticket here for assistance, and don’t forget to check our status page to ensure there are no outages in your area.
Comments
0 comments
Please sign in to leave a comment.