RegistrationDomainService

class RegistrationDomainService

Methods

get_all	List registration domain rules.
create	Create a new registration domain rule.
delete	Delete a registration domain rule.
patch	Update an existing registration domain rule.

get_all(*, tenant_id=Nothing, domain=Nothing, page_size=25)

List registration domain rules.

Parameters:

• tenant_id (Union[Just[str], _Nothing[str]]) – If given, only return results for the given tenant.

• domain (Union[Just[str], _Nothing[str]]) – If given, filter by domain substring (case-insensitive).

• page_size (int) – The size of a single page, maximum is 100.

• self (RegistrationDomainService[AuthenticatedClient])

Returns:

Paginated list of registration domain rules.

Return type:

Response[AllowRegistrationDomain | BlockRegistrationDomain]

create(json_body)

Create a new registration domain rule.

The request body is a tagged union discriminated on the type field:

• allow: maps a domain to a tenant role (requires tenant_role_id). - block: blocks registration for a domain globally.

Parameters:

• json_body (Union[CreateAllowRegistrationDomainData, CreateBlockRegistrationDomainData]) – The body of the request. See CreateRegistrationDomainData for information about the possible fields. You can provide this data as a CreateRegistrationDomainData or as a dictionary.

• self (RegistrationDomainService[AuthenticatedClient])

Returns:

The created registration domain rule.

Return type:

AllowRegistrationDomain | BlockRegistrationDomain

delete(*, domain_id)

Delete a registration domain rule.

Parameters:

• domain_id (str) – The id of the rule to delete.

• self (RegistrationDomainService[AuthenticatedClient])

Returns:

Empty response.

Return type:

None

patch(json_body, *, domain_id)

Update an existing registration domain rule.

All fields are optional — only the provided fields are updated.

Parameters:

• json_body (Union[PatchAllowRegistrationDomainData, PatchBlockRegistrationDomainData, PatchBaseRegistrationDomainData]) – The body of the request. See PatchRegistrationDomainData for information about the possible fields. You can provide this data as a PatchRegistrationDomainData or as a dictionary.

• domain_id (str) – The id of the rule to update.

• self (RegistrationDomainService[AuthenticatedClient])

Returns:

The updated registration domain rule.

Return type:

AllowRegistrationDomain | BlockRegistrationDomain