# Cirrus Documentation ## Cirrus Bridge - [Introduction](/bridge/overview/introduction.md): What is Cirrus Bridge? - [Getting Started](/bridge/overview/getting-started.md): Preparing your authentication provider. - [Entra ID API Integration](/bridge/enterprise/entra/api.md): How to grant read-only permissions. - [Entra ID Authentication Profiles](/bridge/enterprise/entra/profile.md): Creating an authentication profile to integrate Bridge. - [Okta API Integration](/bridge/enterprise/okta/api.md): How to grant read-only permissions. - [Okta Authentication Profiles](/bridge/enterprise/okta/profile.md): Creating an authentication profile to integrate Bridge. - [Duo API Integration](/bridge/enterprise/duo/api.md): How to grant read-only permissions. - [Duo Authentication Profiles](/bridge/enterprise/duo/profile.md): Creating an authentication profile to integrate Bridge. - [Create Authentication Profile](/bridge/standalone/profile.md): Integrate any SAML authentication provider. - [CAS Applications](/bridge/proxy/integrations/cas/app.md): Add or edit CAS app configuration for Bridge & Proxy. - [SAML Applications](/bridge/proxy/integrations/saml/app.md): Add or edit SAML app configuration for Bridge & Proxy. - [CAS Protocol Enablement](/bridge/other/cas.md): Configure authentication profiles for CAS. - [Register Bridge With InCommon](/bridge/other/incommon.md): How to register your Cirrus Bridge with the federation. - [Handling Logout](/bridge/other/logout.md): Notes on logout for Cirrus Bridge. - [Conducting Testing](/bridge/other/testing.md): How to test integration with Cirrus Bridge. ## Cirrus Proxy - [Introduction](/proxy/overview/introduction.md): What is Cirrus Proxy? - [Federated Providers](/proxy/authentication/federated.md): Using federated authentication providers with Proxy. - [Other Providers](/proxy/authentication/non-federated.md): Using non-federated authentication providers with Proxy. - [Discovery](/proxy/authentication/provider-discovery.md): Configure the Proxy's sign-in user interface. - [Other Configuration](/proxy/authentication/provider-other.md): Adjust Proxy behavior for specific scenarios. - [CAS Applications](/proxy/integrations/cas/app.md): Add or edit CAS app configuration for Bridge & Proxy. - [OIDC Applications](/proxy/integrations/oidc/app.md): Add or edit OIDC app configuration for Proxy. - [SAML Applications](/proxy/integrations/saml/app.md): Add or edit SAML app configuration for Bridge & Proxy. - [Register Proxy With InCommon](/proxy/integrations/federation/publish.md): How to register your Cirrus Proxy with the federation. ## Managed Identities - [Introduction](/managed-identities/overview/introduction.md): What is Managed Identities? - [Identity](/managed-identities/identity/about.md): What is an identity record? - [Create Identity](/managed-identities/identity/create.md): How to create an identity record. - [Credential](/managed-identities/credential/about.md): What is a credential? - [Attribute Collections](/managed-identities/attribute-collections/about.md): What is an attribute collection? - [Create Attribute Collection](/managed-identities/attribute-collections/create.md): How to create an attribute authority & collection. - [Administrative Access](/managed-identities/administration/admins.md): Delegating access for IDAdmin. - [API Access](/managed-identities/administration/api-access.md): Delegating credentials for the Identities API. - [Configure Email Handler](/managed-identities/administration/email-handler.md): Setting up custom SMTP settings for Cirrus email notifications. ## Guides - [Connecting Slate To Proxy](/guides/slate/connector.md): Using Slate & Cirrus Proxy to make applicant access easy. - [Discovery & Attribute Mapping](/guides/slate/discovery.md): Map your attributes first to ensure smooth integration. - [Trusting Authentication Providers](/guides/slate/providers.md): Setting up trust between Proxy, Providers, & Slate. - [Integrate & Test Applications](/guides/slate/testing.md): Test your Slate login with Proxy-integrated apps. - [About IDWorkflow](/guides/idworkflow/about.md): Using IDWorkflow & Cirrus Proxy to present custom content. - [Create Flows](/guides/idworkflow/create-flow.md): Make your first flow and wire components together. - [Test & Publish Flows](/guides/idworkflow/publish-flow.md): Pushing content to production. - [Beginner's Guide to Cirrus Console](/guides/console/introduction.md): An introduction to the various configuration possible in the Console. - [Setting Up One-Time Code MFA](/guides/console/one-time-mfa.md): How to configure OTC MFA in the Cirrus Console. - [Log Export Via File](/guides/logs/export.md): Using the export event logs tool in Cirrus Console. - [Log Export Data Definitions](/guides/logs/reference.md): Interpreting exported event logs from Cirrus Console. - [Fetch Logs Via API](/guides/logs/stream.md): Using the Cirrus Log API. ## Identities API - [Cirrus Identity Identities API](/identities-api.md): Identities API credentials are managed by organizational admins in the Cirrus Console. - [Fetch Permissions](/identities-api/operations/operation-permissions-get.md): Return permissions for the current credential. - [List Identities](/identities-api/operations/operation-list-environment-get.md): List all identity records for a specific environment (test or prod). - [List Identities By Attr Collection](/identities-api/operations/operation-list-byattributecollection-environment-get.md): List all identity records associated with a specific attributeCollectionAuthority (e.g., records containing an alumni attribute collection), or a combination of attributeCollectionAuthority and uid (e.g., find the alumni record with alumni uid of '1234567'). - [Search Identities](/identities-api/operations/operation-search-environment-searchterm-get.md): List cirrusUid values for identity records matching search term. Search includes attribute collections. - [Fetch Identity](/identities-api/operations/operation-fetch-cirrusuid-get.md): Retrieve a single identity record by cirrusUid. - [Create Identity](/identities-api/operations/operation-create-environment-post.md): Create an identity record, including optional additions as permitted for your credential: - obid - Create an OrgBrandedID sign-in credential for the identity, inviting the user to set a password for it, e.g.: "obid": true - quiet - Suppress any user-facing emails that might be triggered as a result of account creation… - [Modify Identity](/identities-api/operations/operation-modify-cirrusuid-patch.md): Modify core attributes of identity record. - [Create Attribute Collection](/identities-api/operations/operation-attributecollections-create-cirrusuid-post.md): Create a new attribute collection under an authorized authority for an existing identity record. - [Modify Attribute Collection](/identities-api/operations/operation-attributecollections-modify-cirrusuid-put.md): Modify a specific attribute collection under an authorized authority for an identity record. - [Delete Attribute Collection](/identities-api/operations/operation-attributecollections-delete-cirrusuid-delete.md): Delete a specific attribute collection under an authorized authority from an identity record. - [Create Remote Credential](/identities-api/operations/operation-remotecredentials-create-cirrusuid-post.md): Create a new remote credential under an existing identity record. - [Delete Remote Credential](/identities-api/operations/operation-remotecredentials-delete-cirrusuid-delete.md): Delete a specific remote credential under an identity record. - [Create Obid](/identities-api/operations/operation-obids-create-cirrusuid-post.md): Create a new OrgBrandedID sign-in credential for an existing identity record, sending an onboarding email to the designated email address. The quiet flag can be used to suppress the OrgBrandedID account setup email. - [Send Obid Credential Email](/identities-api/operations/operation-obids-cirrusuid-sendcredentialemail-cuid-post.md): Send a credential email for the OBID account cuid associated with identity cirrusUid. If the OBID account is in either the BOOTSTRAP or INACTIVE state, the "account activation" email will be sent. Otherwise, the "password reset" email will be sent. - [AttributeCollectionAuthorityType](/identities-api/schemas/attributecollectionauthoritytype-eac0393eb0.md): enum for deployment patterns - [AttributeCollectionCreateOrModifyOutput](/identities-api/schemas/attributecollectioncreateormodifyoutput-fac9e6d321.md): wrapper for returning attribute collections along with cirrusUid - [AttributeCollectionInput](/identities-api/schemas/attributecollectioninput-8b18f20195.md): attribute collection model - [AttributeCollectionOutput](/identities-api/schemas/attributecollectionoutput-b54f0f0eb9.md): output attribute collection model - [HTTPValidationError](/identities-api/schemas/httpvalidationerror-231eeffce0.md): Field: detail. - [IdentitiesApiUserPermissionsModel](/identities-api/schemas/identitiesapiuserpermissionsmodel-294e34917d.md): model for user/permissions model (for identities API) - [IdentityCreateInput](/identities-api/schemas/identitycreateinput-b5a7def79f.md): model for creating a new identity record - [IdentityEnvironment](/identities-api/schemas/identityenvironment-345e0efae6.md): enum for allowed linking environments - [IdentityListSortKey](/identities-api/schemas/identitylistsortkey-48f2ced11c.md): enum for allowed fields to sort identity list by - [IdentityListSortOrder](/identities-api/schemas/identitylistsortorder-0f73f3588b.md): enum for allowed orders to sort identity list by - [IdentityModel](/identities-api/schemas/identitymodel-4d7b1c2967.md): full identity model - [IdentityModelBase](/identities-api/schemas/identitymodelbase-2589bb3c1a.md): base identity model - [IdentityModifyInput](/identities-api/schemas/identitymodifyinput-71949ff41d.md): model for modifying base properties on existing identity record - [LinkGroup](/identities-api/schemas/linkgroup-dbde2db3db.md): linkgroup model - [OrgBrandedIdAccountCreateInput](/identities-api/schemas/orgbrandedidaccountcreateinput-68329e5382.md): model for creating a new OBID account - [Page_IdentityModelBase_](/identities-api/schemas/page-identitymodelbase-cf739db49c.md): Fields: items, total_items, page_cnt, page_size and page_idx. - [Page_IdentityModel_](/identities-api/schemas/page-identitymodel-0245038f7a.md): Fields: items, total_items, page_cnt, page_size and page_idx. - [RemoteCredentialInput](/identities-api/schemas/remotecredentialinput-78aa5053c9.md): remote credential model - [ValidationError](/identities-api/schemas/validationerror-bdfaef14be.md): Fields: loc, msg, type, input and ctx. ## Log API - [Cirrus Identity Log API](/log-api.md): All endpoints require HTTP Basic authentication using Cirrus Identity Log API credentials, provisioned in the Cirrus Console. - [Return Logs For A Specified Org Url](/log-api/operations/operation-orglogs-get.md): Returns an array of log events for the specified orgUrl value. - [Return A List Of Permitted Org Urls](/log-api/operations/operation-orgurls-get.md): Returns an array of orgUrl values that the current authenticated user is permitted to use (in the orgUrl query parameter for the / endpoint) for retrieving logs. - [HTTPValidationError](/log-api/schemas/httpvalidationerror-231eeffce0.md): Field: detail. - [LogApiResponse](/log-api/schemas/logapiresponse-a0e0371ebe.md): wrapper response for log items - [LogSubtypesEnum](/log-api/schemas/logsubtypesenum-a9636c87c6.md): enum for Cirrus log subtypes - [LogTypesEnum](/log-api/schemas/logtypesenum-ce17276e5a.md): enum for Cirrus log types - [ServiceTypesEnum](/log-api/schemas/servicetypesenum-00c819aa6a.md): enum for valid Cirrus services - [ValidationError](/log-api/schemas/validationerror-bdfaef14be.md): Fields: loc, msg, type, input and ctx.