# This file was auto-generated by Fern from our API Definition.
import typing
from json.decoder import JSONDecodeError
from ...core.api_error import ApiError
from ...core.client_wrapper import AsyncClientWrapper, SyncClientWrapper
from ...core.http_response import AsyncHttpResponse, HttpResponse
from ...core.request_options import RequestOptions
from ...core.serialization import convert_and_respect_annotation_metadata
from ...core.unchecked_base_model import construct_type
from ...types.project_group_request import ProjectGroupRequest
from ...types.saml_settings import SamlSettings
from ...types.saml_settings_update import SamlSettingsUpdate
# this is used as the default value for optional parameters
OMIT = typing.cast(typing.Any, ...)
class RawSamlClient:
def __init__(self, *, client_wrapper: SyncClientWrapper):
self._client_wrapper = client_wrapper
def get(self, *, request_options: typing.Optional[RequestOptions] = None) -> HttpResponse[SamlSettings]:
"""
This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise)
Retrieve SAML2 settings for the currently active organization.
Parameters
----------
request_options : typing.Optional[RequestOptions]
Request-specific configuration.
Returns
-------
HttpResponse[SamlSettings]
"""
_response = self._client_wrapper.httpx_client.request(
"api/saml/settings",
method="GET",
request_options=request_options,
)
try:
if 200 <= _response.status_code < 300:
_data = typing.cast(
SamlSettings,
construct_type(
type_=SamlSettings, # type: ignore
object_=_response.json(),
),
)
return HttpResponse(response=_response, data=_data)
_response_json = _response.json()
except JSONDecodeError:
raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response.text)
raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response_json)
def update(
self,
*,
domain: typing.Optional[str] = OMIT,
mapping_email: typing.Optional[str] = OMIT,
mapping_first_name: typing.Optional[str] = OMIT,
mapping_groups: typing.Optional[str] = OMIT,
mapping_last_name: typing.Optional[str] = OMIT,
metadata_url: typing.Optional[str] = OMIT,
metadata_xml: typing.Optional[str] = OMIT,
projects_groups: typing.Optional[typing.Sequence[ProjectGroupRequest]] = OMIT,
roles_groups: typing.Optional[typing.Sequence[typing.Sequence[str]]] = OMIT,
workspaces_groups: typing.Optional[typing.Sequence[typing.Sequence[str]]] = OMIT,
request_options: typing.Optional[RequestOptions] = None,
) -> HttpResponse[SamlSettingsUpdate]:
"""
This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise)
Update SAML2 settings for the currently active organization.
Parameters
----------
domain : typing.Optional[str]
Organization web domain or domains; use comma separated list with no spaces for multiple. Example:
labelstud.io,humansignal.com
IMPORTANT: DO NOT PUT COMMON DOMAINS LIKE GMAIL.COM, YAHOO.COM, ETC. IN THIS FIELD
mapping_email : typing.Optional[str]
Mapping attributes: user email from SAML request
mapping_first_name : typing.Optional[str]
Mapping attributes: user first name from SAML request
mapping_groups : typing.Optional[str]
Mapping attributes: groups attribute for user mapping to workspaces and roles
mapping_last_name : typing.Optional[str]
Mapping attributes: user last name from SAML request
metadata_url : typing.Optional[str]
URL SAML metadata from IdP
metadata_xml : typing.Optional[str]
Metadata XML file
projects_groups : typing.Optional[typing.Sequence[ProjectGroupRequest]]
Projects to Groups Mapping. List of objects with project_id, group, role.
roles_groups : typing.Optional[typing.Sequence[typing.Sequence[str]]]
Organization Roles to Groups Mapping. List of [role_name, group_name] pairs.
workspaces_groups : typing.Optional[typing.Sequence[typing.Sequence[str]]]
Workspaces to Groups Mapping. List of [workspace_title, group_name] pairs.
request_options : typing.Optional[RequestOptions]
Request-specific configuration.
Returns
-------
HttpResponse[SamlSettingsUpdate]
"""
_response = self._client_wrapper.httpx_client.request(
"api/saml/settings",
method="POST",
json={
"domain": domain,
"mapping_email": mapping_email,
"mapping_first_name": mapping_first_name,
"mapping_groups": mapping_groups,
"mapping_last_name": mapping_last_name,
"metadata_url": metadata_url,
"metadata_xml": metadata_xml,
"projects_groups": convert_and_respect_annotation_metadata(
object_=projects_groups, annotation=typing.Sequence[ProjectGroupRequest], direction="write"
),
"roles_groups": roles_groups,
"workspaces_groups": workspaces_groups,
},
headers={
"content-type": "application/json",
},
request_options=request_options,
omit=OMIT,
)
try:
if 200 <= _response.status_code < 300:
_data = typing.cast(
SamlSettingsUpdate,
construct_type(
type_=SamlSettingsUpdate, # type: ignore
object_=_response.json(),
),
)
return HttpResponse(response=_response, data=_data)
_response_json = _response.json()
except JSONDecodeError:
raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response.text)
raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response_json)
class AsyncRawSamlClient:
def __init__(self, *, client_wrapper: AsyncClientWrapper):
self._client_wrapper = client_wrapper
async def get(self, *, request_options: typing.Optional[RequestOptions] = None) -> AsyncHttpResponse[SamlSettings]:
"""
This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise)
Retrieve SAML2 settings for the currently active organization.
Parameters
----------
request_options : typing.Optional[RequestOptions]
Request-specific configuration.
Returns
-------
AsyncHttpResponse[SamlSettings]
"""
_response = await self._client_wrapper.httpx_client.request(
"api/saml/settings",
method="GET",
request_options=request_options,
)
try:
if 200 <= _response.status_code < 300:
_data = typing.cast(
SamlSettings,
construct_type(
type_=SamlSettings, # type: ignore
object_=_response.json(),
),
)
return AsyncHttpResponse(response=_response, data=_data)
_response_json = _response.json()
except JSONDecodeError:
raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response.text)
raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response_json)
async def update(
self,
*,
domain: typing.Optional[str] = OMIT,
mapping_email: typing.Optional[str] = OMIT,
mapping_first_name: typing.Optional[str] = OMIT,
mapping_groups: typing.Optional[str] = OMIT,
mapping_last_name: typing.Optional[str] = OMIT,
metadata_url: typing.Optional[str] = OMIT,
metadata_xml: typing.Optional[str] = OMIT,
projects_groups: typing.Optional[typing.Sequence[ProjectGroupRequest]] = OMIT,
roles_groups: typing.Optional[typing.Sequence[typing.Sequence[str]]] = OMIT,
workspaces_groups: typing.Optional[typing.Sequence[typing.Sequence[str]]] = OMIT,
request_options: typing.Optional[RequestOptions] = None,
) -> AsyncHttpResponse[SamlSettingsUpdate]:
"""
This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise)
Update SAML2 settings for the currently active organization.
Parameters
----------
domain : typing.Optional[str]
Organization web domain or domains; use comma separated list with no spaces for multiple. Example:
labelstud.io,humansignal.com
IMPORTANT: DO NOT PUT COMMON DOMAINS LIKE GMAIL.COM, YAHOO.COM, ETC. IN THIS FIELD
mapping_email : typing.Optional[str]
Mapping attributes: user email from SAML request
mapping_first_name : typing.Optional[str]
Mapping attributes: user first name from SAML request
mapping_groups : typing.Optional[str]
Mapping attributes: groups attribute for user mapping to workspaces and roles
mapping_last_name : typing.Optional[str]
Mapping attributes: user last name from SAML request
metadata_url : typing.Optional[str]
URL SAML metadata from IdP
metadata_xml : typing.Optional[str]
Metadata XML file
projects_groups : typing.Optional[typing.Sequence[ProjectGroupRequest]]
Projects to Groups Mapping. List of objects with project_id, group, role.
roles_groups : typing.Optional[typing.Sequence[typing.Sequence[str]]]
Organization Roles to Groups Mapping. List of [role_name, group_name] pairs.
workspaces_groups : typing.Optional[typing.Sequence[typing.Sequence[str]]]
Workspaces to Groups Mapping. List of [workspace_title, group_name] pairs.
request_options : typing.Optional[RequestOptions]
Request-specific configuration.
Returns
-------
AsyncHttpResponse[SamlSettingsUpdate]
"""
_response = await self._client_wrapper.httpx_client.request(
"api/saml/settings",
method="POST",
json={
"domain": domain,
"mapping_email": mapping_email,
"mapping_first_name": mapping_first_name,
"mapping_groups": mapping_groups,
"mapping_last_name": mapping_last_name,
"metadata_url": metadata_url,
"metadata_xml": metadata_xml,
"projects_groups": convert_and_respect_annotation_metadata(
object_=projects_groups, annotation=typing.Sequence[ProjectGroupRequest], direction="write"
),
"roles_groups": roles_groups,
"workspaces_groups": workspaces_groups,
},
headers={
"content-type": "application/json",
},
request_options=request_options,
omit=OMIT,
)
try:
if 200 <= _response.status_code < 300:
_data = typing.cast(
SamlSettingsUpdate,
construct_type(
type_=SamlSettingsUpdate, # type: ignore
object_=_response.json(),
),
)
return AsyncHttpResponse(response=_response, data=_data)
_response_json = _response.json()
except JSONDecodeError:
raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response.text)
raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response_json)