Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Self Service SSO GA release changes #1057

Merged
merged 4 commits into from
Nov 22, 2024
Merged

Conversation

tusharpandey13
Copy link
Contributor

@tusharpandey13 tusharpandey13 commented Nov 21, 2024

Changes

Updated SelfServiceProfilesManager method names

Path HTTP Method Method Name
/self-service-profiles GET getAll
/self-service-profiles POST create
/self-service-profiles/{id} GET get
/self-service-profiles/{id} DELETE delete
/self-service-profiles/{id} PATCH update
/self-service-profiles/{id}/sso-ticket POST createSsoTicket
/self-service-profiles/{id}/custom-text/{language}/{page} GET getCustomText
/self-service-profiles/{id}/custom-text/{language}/{page} PUT updateCustomText
/self-service-profiles/{profileId}/sso-ticket/{id}/revoke POST revokeSsoTicket

More details below:

Modified: POST /api/v2/self-service-profiles

  • New Query Parameters:
    • name (string) Required

      • Length: 1 <= length <= 100
      • Description: The name of the self-service profile.
    • description (string)

      • Length: 1 <= length <= 140
      • Description: The description of the self-service profile.
    • allowed_strategies (string[])

      • Description: List of IdP strategies shown to users during the Self-Service SSO flow.
      • Possible values: [oidc, samlp, waad, google-apps, adfs, okta, keycloak-samlp, pingfederate]

New: PUT /api/v2/self-service-profiles/{id}/custom-text/{language}/{page}

Updates text customizations for a given self-service profile, language, and Self-Service SSO flow page.

  • Scope: update:self_service_profile_custom_texts

  • Path Parameters:

    • id (string) Required: The ID of the self-service profile.
    • language (string) Required: The language of the custom text.
    • page (string) Required: The page where the custom text is shown.
  • Body Parameters:

    • Returns an object containing key/value pairs.
    • Contains text keys and values for customizing the self-service SSO page. Values can be plain text or rich HTML (limited to basic styling tags and hyperlinks).
    • Each value can be up to 2000 characters.
    • Currently supported languages: en.
    • Supported pages: get-started.
    • Supported keys for get-started: introduction.

Note: Language, page, and key support can change at any time and should be treated as text fields from the SDK's perspective.


New: GET /api/v2/self-service-profiles/{id}/custom-text/{language}/{page}

Retrieves custom text for a self-service profile.

  • Scope: read:self_service_profile_custom_texts

  • Path Parameters:

    • id (string) Required: The ID of the self-service profile.
    • language (string) Required: The language of the custom text.
    • page (string) Required: The page where the custom text is shown.
  • Response: Returns a list of key/value pairs, or an empty object {} if none are set.


Modified: POST /api/v2/self-service-profiles/{id}/sso-ticket

  • New Query Parameters: When creating a new SSO ticket, the following optional parameters are supported:

    • Connections:

      • domain_aliases
      • display_name
      • is_domain_connection
      • show_as_button
      • metadata
      • icon_url
    • Organizations:

      • assign_membership_on_login
      • show_as_button
    • ttl_sec

      • Maximum: 5 days.
      • Default: 5 days (432,000 seconds) if not specified.
  • Sample Request Body:

    {
      "connection_config": {
        "name": "string",
        "display_name": "string",
        "is_domain_connection": true,
        "show_as_button": true,
        "metadata": {
          "key1": "value1",
          "key2": "value2"
        },
        "options": {
          "icon_url": "string",
          "domain_aliases": ["acme.corp", "okta.com"]
        }
      },
      "enabled_clients": ["string"],
      "enabled_organizations": [
        {
          "organization_id": "string",
          "assign_membership_on_login": true,
          "show_as_button": true
        }
      ],
      "ttl_sec": 0
    }
    

New: POST /api/v2/self-service-profiles/{id}/sso-ticket/{id}/revoke

  • Scope: delete:sso_access_tickets

  • Description:
    Revokes a ticket.

    • Returns 202 Accepted with no body content.

References

https://auth0.com/docs/api/management/v2/self-service-profiles/get-self-service-profiles

Testing

We will release guides to use this features separately that can help in manual testing.

Test Suites: 43 passed, 43 total
Tests:       1413 passed, 1413 total
Snapshots:   0 total
Time:        6.702 s
  • This change adds unit test coverage
  • This change adds integration test coverage

Checklist

@tusharpandey13 tusharpandey13 requested a review from a team as a code owner November 21, 2024 12:33
kushalshit27
kushalshit27 previously approved these changes Nov 21, 2024
@tusharpandey13 tusharpandey13 merged commit bab52e9 into master Nov 22, 2024
4 checks passed
@tusharpandey13 tusharpandey13 deleted the feature/ss-sso-ga branch November 22, 2024 06:34
This was referenced Nov 22, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants