Update Organization Name Component

PropelAuth's Update Organization Name component allows you to customize the flow around a user updating an organization's name in your app.

Update Organization Name

Not sure how to use this component? Check out the Using the Documentation page.

Reference APIs

These are the APIs that are used by the above component. You can use these APIs directly in your own code.

updateOrgSettings

Updates the settings for an organization.

Arguments

Name
org_id *
Type
string
Description
The ID of the org to be updated.
Name
name
Type
string
Description
The new name of the org.
Name
allow_users_to_join_by_domain
Type
boolean
Description
If a domain is set for the org, new users can join the org if their domain matches the org's domain.
Name
restrict_invites_by_domain
Type
boolean
Description
If a domain is set for the org, only allow users with that domain to join.
Name
require_2fa_by
Type
date
Description
If requiring 2FA for an org, the date you want to enforce it by.

Response Functions

The response object has a handle function that you can use to handle the response. These functions can be async, and you can return values from them.

Name
success
Description
Successful request.
Name
orgsNotEnabled
Description
Organizations are not enabled in this project.
Name
orgNotFound
Description
The provided orgId was not found
Name
forbidden
Description
The user does not have permission to edit the org.
Name
badRequest
Description
Incorrect arguments given.
Name
unauthorized
Description
The user is not logged in.
Name
unexpectedOrUnhandled
Description
An unexpected error occurred.

Request

const { updateOrgSettings } = useAuthFrontendApis()

const response = await updateOrgSettings({
    org_id: '1189c444-8a2d-4c41-8b4b-ae43ce79a492',
    name: 'Acme Inc',
    allow_users_to_join_by_domain: true,
    restrict_invites_by_domain: true,
    require_2fa_by: '2025-01-16T00:00:00.000Z',
})
response.handle({
    success() {
        console.log('Updated org settings successfully.')
    },
    badRequest(error) {
        for (const [field, fieldErrorMessage] of Object.entries(error.user_facing_errors)) {
            console.log('Error: "' + fieldErrorMessage + '" for field: "' + field + '"')
        }
    },
    orgsNotEnabled(error) {
        console.log('Org not enabled', error)
    },
    orgNotFound(error) {
        console.log('Org not found', error)
    },
    forbidden(error) {
        console.log('Forbidden', error)
    },
    unexpectedOrUnhandled(error) {
        console.log('Unexpected or unhandled error', error)
    },
})

Successful Response

{}