DOCSEARCHbyAlgolia
Submit Docs

Okta .NET Management SDK

repository·master·Indexed 41 days ago

https://github.com/okta/okta-sdk-dotnet

A server-side .NET SDK for interacting with the Okta management API to manage users, groups, applications, and logs. Compatible with .NET Standard 2.1, .NET Framework 4.6.1+, .NET Core 3.0+, and .NET 5.0+. Features include support for OAuth 2.0 Private Key authentication, hardware-backed keys via PrivateKeySigningCredentials, and a fluent builder syntax introduced in version 9.2.0.

Tokens
429.1K
Snippets
734
Records
795
Agent score
51%

What's inside Okta

  1. Overview of OrgSettingSupportApi

    master

    The OrgSettingSupportApi class provides methods to manage Okta Support access and Okta Aerial consent for your organization. This includes extending support access, retrieving support settings, granting or revoking Aerial consent, and managing support cases.

    Available Methods:

    • ExtendOktaSupport: Extends Okta Support access by 24 hours (Deprecated).
    • GetAerialConsent: Retrieves Okta Aerial consent details.
    • GetOrgOktaSupportSettings: Retrieves Okta Support settings.
    • GrantAerialConsent: Grants Okta Aerial access.
    • GrantOktaSupport: Grants Okta Support access.
    • ListOktaSupportCases: Lists all Okta Support cases.
    • RevokeAerialConsent: Revokes Okta Aerial access.
    • RevokeOktaSupport: Revokes Okta Support access.
    • UpdateOktaSupportCase: Updates a specific Okta Support case.

  3. Use AssociatedDomainCustomizationsApi to manage well-known URIs

    master

    The AssociatedDomainCustomizationsApi class allows you to retrieve and manage customized well-known URI content (such as Apple App Site Association or Android Asset Links) for specific brands in Okta. All URIs are relative to your Okta domain (e.g., https://subdomain.okta.com).

    Available methods include:

    • GetAllWellKnownURIs: Retrieve all well-known URIs for a brand.
    • GetAppleAppSiteAssociationWellKnownURI: Retrieve the customized apple-app-site-association content.
    • GetAssetLinksWellKnownURI: Retrieve the customized assetlinks.json content.
    • GetBrandWellKnownURI: Retrieve customized content for a specific brand and path.
    • GetWebAuthnWellKnownURI: Retrieve customized webauthn content.
    • ReplaceBrandWellKnownURI: Replace the customized content for a specific path.
    var apiInstance = new AssociatedDomainCustomizationsApi(config);

  4. Explore Okta SDK Model documentation

    master

    The Okta .NET SDK provides a comprehensive set of model classes that map to Okta API resources. You can find detailed documentation for specific data structures, request bodies, and response objects in the docs/ directory.

    Key areas of the model include:

    • Provisioning: Models for managing user provisioning, connections, and actions (e.g., ProvisioningDetails, ProvisioningGroups).
    • Registration & Hooks: Models for handling registration flows and inline hooks (e.g., RegistrationInlineHookRequest, RegistrationResponse).
    • Resource Sets: Models for managing resource set bindings and members (e.g., ResourceSetBinding, ResourceSetResource).
    • Risk & Security: Models for risk detection, policy rules, and risk events (e.g., RiskEvent, RiskPolicyRuleCondition).
    • SAML & SSO: Extensive models for SAML applications, payloads, and assertions (e.g., SamlApplication, SAMLPayLoad).
    • Roles & Governance: Models for managing roles and role governance (e.g., Role, RoleGovernance).

  6. Manage custom SMTP servers with EmailServerApi

    master

    The EmailServerApi class allows you to manage custom SMTP server configurations for your Okta organization. You can create, delete, retrieve, list, test, and update SMTP server settings. All requests are relative to your Okta domain (e.g., https://subdomain.okta.com).

    Available methods:

    • CreateEmailServer: Create a custom SMTP server configuration.
    • DeleteEmailServer: Delete an existing SMTP server configuration.
    • GetEmailServer: Retrieve a specific SMTP server configuration by ID.
    • ListEmailServers: List all enrolled SMTP servers.
    • TestEmailServer: Test a specific SMTP server configuration.
    • UpdateEmailServer: Update an existing SMTP server configuration.

  7. Manage Identity Provider (IdP) keys with IdentityProviderKeysApi

    master

    The IdentityProviderKeysApi class allows you to manage X.509 certificate credentials in the identity provider (IdP) key store. You can create, retrieve, list, replace, and delete IdP key credentials.

    Supported Certificate Types:

    • RSA-based certificates: Supported for all IdP types.
    • EC-based certificates: Supported only for the X509 IdP type. Supported curves are P-256, P-384, and P-521.

  8. Manage Custom Domains with CustomDomainApi

    master

    The CustomDomainApi class provides methods to manage custom domains for your Okta organization. All requests are relative to your Okta domain (e.g., https://subdomain.okta.com).

    Available operations:

    • CreateCustomDomain: Creates a new custom domain.
    • DeleteCustomDomain: Deletes an existing custom domain by its ID.
    • GetCustomDomain: Retrieves details for a specific custom domain.
    • ListCustomDomains: Lists all verified custom domains for the organization.
    • ReplaceCustomDomain: Replaces a custom domain's brand.
    • UpsertCertificate: Manages the custom domain's certificate.
    • VerifyDomain: Verifies a custom domain.

  12. Explore Okta SDK Model documentation

    master

    The Okta .NET SDK provides a comprehensive set of model classes that represent the data structures used by the Okta Management API. These models are organized under the Model namespace and correspond to various entities such as Group, EmailSettings, EventHook, Domain, and EntityRiskPolicy.

    Each model documentation page provides details on the properties, types, and relationships of the specific entity, allowing you to construct requests and parse responses with type safety. For example, if you are managing groups, you would refer to Model.Group and its associated schema models like Model.GroupSchema.