Skip to content
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
312 changes: 312 additions & 0 deletions fern/openapi/openapi.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -6106,6 +6106,115 @@ paths:
- member_tags
- bulk
x-fern-sdk-method-name: post
/api/organizations/{id}/member-tags/imports:
post:
description: |-
<Card href="https://humansignal.com/goenterprise">
<img style="pointer-events: none; margin-left: 0px; margin-right: 0px;" src="https://docs.humansignal.com/images/badge.svg" alt="Label Studio Enterprise badge"/>
<p style="margin-top: 10px; font-size: 14px;">
This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise)
</p>
</Card>
Upload a CSV file to bulk import member tags and assign them to organization members.

The CSV file must contain `email` and `tags` columns. The `tags` column should contain comma-separated tag labels (quoted if they contain commas). Tags that do not exist will be created.

Optionally, you can specify `bulk_tags` as a comma-separated list of tags to apply to all users in the CSV file.

The import runs asynchronously. Use the returned import job ID to check the status.
operationId: api_organizations_member_tags_imports_create
parameters:
- description: A unique integer value identifying this organization.
in: path
name: id
required: true
schema:
type: integer
requestBody:
content:
application/x-www-form-urlencoded:
schema:
$ref: '#/components/schemas/OrganizationMemberTagImportCreateRequest'
multipart/form-data:
schema:
$ref: '#/components/schemas/OrganizationMemberTagImportCreateRequest'
required: true
responses:
'201':
content:
application/json:
schema:
properties:
import:
description: The ID of the created import job
type: integer
type: object
description: Import job created successfully
'400':
description: Bad Request - Invalid CSV file or missing required columns
'403':
description: Permission Denied
security:
- Token: []
summary: ✨ Import member tags from CSV
tags:
- Organizations
- Member Tags
x-fern-audiences:
- public
x-fern-sdk-group-name:
- organizations
- member_tags
x-fern-sdk-method-name: import
/api/organizations/{id}/member-tags/imports/{import_pk}:
get:
description: |-
<Card href="https://humansignal.com/goenterprise">
<img style="pointer-events: none; margin-left: 0px; margin-right: 0px;" src="https://docs.humansignal.com/images/badge.svg" alt="Label Studio Enterprise badge"/>
<p style="margin-top: 10px; font-size: 14px;">
This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise)
</p>
</Card>
Retrieve the status and results of a member tag import job.

The response includes the current status (created, in_progress, completed, failed), timestamps, and counts of tags created, assignments made, and users skipped.
operationId: api_organizations_member_tags_imports_retrieve
parameters:
- description: A unique integer value identifying this organization.
in: path
name: id
required: true
schema:
type: integer
- description: A unique integer value identifying this import job.
in: path
name: import_pk
required: true
schema:
type: integer
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/OrganizationMemberTagImportStatus'
description: ''
'403':
description: Permission Denied
'404':
description: Import job not found
security:
- Token: []
summary: ✨ Get member tag import status
tags:
- Organizations
- Member Tags
x-fern-audiences:
- public
x-fern-sdk-group-name:
- organizations
- member_tags
x-fern-sdk-method-name: get_import
/api/organizations/{id}/member-tags/{tag_pk}:
delete:
description: |-
Expand Down Expand Up @@ -19468,6 +19577,11 @@ paths:
List all workspaces for your organization. Workspaces in Label Studio let you organize your projects and users into separate spaces. This is useful for managing different teams, departments, or projects within your organization. For more information, see the [Workspaces documentation](https://docs.humansignal.com/workspaces).
operationId: api_workspaces_list
parameters:
- description: Include all workspaces in the organization, including other users' personal workspaces. Only effective for users with Administrator or Owner role. When enabled, the response includes created_by_user info for personal workspaces.
in: query
name: include_all_workspaces
schema:
type: boolean
- description: Workspace is a personal user workspace.
in: query
name: is_personal
Expand Down Expand Up @@ -29385,6 +29499,58 @@ components:
required:
- labels
type: object
OrganizationMemberTagImportCreateRequest:
properties:
bulk_tags:
type: string
file:
format: binary
type: string
required:
- bulk_tags
- file
type: object
OrganizationMemberTagImportStatus:
description: Serializer for the status of a member tag import job.
properties:
assignments_created:
maximum: 2147483647
minimum: -2147483648
type: integer
created_at:
format: date-time
readOnly: true
type: string
finished_at:
format: date-time
nullable: true
type: string
id:
readOnly: true
type: integer
status:
$ref: '#/components/schemas/OrganizationMemberTagImportStatusStatusEnum'
tags_created:
maximum: 2147483647
minimum: -2147483648
type: integer
users_skipped: {}
required:
- created_at
- id
type: object
OrganizationMemberTagImportStatusStatusEnum:
description: |-
* `created` - Created
* `in_progress` - In Progress
* `completed` - Completed
* `failed` - Failed
enum:
- created
- in_progress
- completed
- failed
type: string
OrganizationMemberTagRequest:
properties:
label:
Expand Down Expand Up @@ -33617,19 +33783,123 @@ components:
- type
type: object
SamlSettings:
description: |-
Serializer for reading SAML settings (GET requests).

Includes all model fields plus computed read-only fields for SP URLs
that are needed for IdP configuration.
properties:
acs_url:
readOnly: true
type: string
domain:
description: 'Organization web domain or domains; use comma separated list with no spaces for multiple. Example:<br><br>labelstud.io,humansignal.com<br><br>IMPORTANT: DO NOT PUT COMMON DOMAINS LIKE GMAIL.COM, YAHOO.COM, ETC. IN THIS FIELD'
maxLength: 65536
minLength: 3
type: string
login_url:
readOnly: true
type: string
logout_url:
readOnly: true
type: string
mapping_email:
description: 'Mapping attributes: user email from SAML request'
maxLength: 1024
minLength: 1
nullable: true
title: Email
type: string
mapping_first_name:
description: 'Mapping attributes: user first name from SAML request'
maxLength: 1024
nullable: true
title: First name
type: string
mapping_groups:
description: 'Mapping attributes: groups attribute for user mapping to workspaces and roles'
maxLength: 1024
nullable: true
title: Groups
type: string
mapping_last_name:
description: 'Mapping attributes: user last name from SAML request'
maxLength: 1024
nullable: true
title: Last name
type: string
metadata_url:
description: URL SAML metadata from IdP
maxLength: 65536
type: string
metadata_xml:
description: Metadata XML file
type: string
metadata_xml_url:
readOnly: true
type: string
nameid_format:
readOnly: true
type: string
projects_groups:
description: Projects to groups mapping
nullable: true
roles_groups:
description: Roles to groups mapping
nullable: true
token:
maxLength: 256
type: string
workspaces_groups:
description: Workspaces to groups mapping
nullable: true
required:
- acs_url
- login_url
- logout_url
- metadata_xml_url
- nameid_format
type: object
SamlSettingsUpdate:
description: Serializer for updating SAML settings (POST requests).
properties:
domain:
description: 'Organization web domain or domains; use comma separated list with no spaces for multiple. Example:<br><br>labelstud.io,humansignal.com<br><br>IMPORTANT: DO NOT PUT COMMON DOMAINS LIKE GMAIL.COM, YAHOO.COM, ETC. IN THIS FIELD'
maxLength: 65536
minLength: 3
type: string
mapping_email:
description: 'Mapping attributes: user email from SAML request'
maxLength: 1024
minLength: 1
nullable: true
title: Email
type: string
mapping_first_name:
description: 'Mapping attributes: user first name from SAML request'
maxLength: 1024
nullable: true
title: First name
type: string
mapping_groups:
description: 'Mapping attributes: groups attribute for user mapping to workspaces and roles'
maxLength: 1024
nullable: true
title: Groups
type: string
mapping_last_name:
description: 'Mapping attributes: user last name from SAML request'
maxLength: 1024
nullable: true
title: Last name
type: string
metadata_url:
description: URL SAML metadata from IdP
maxLength: 65536
type: string
metadata_xml:
description: Metadata XML file
type: string
projects_groups:
items:
$ref: '#/components/schemas/ProjectGroup'
Expand All @@ -33648,7 +33918,45 @@ components:
type: array
type: object
SamlSettingsUpdateRequest:
description: Serializer for updating SAML settings (POST requests).
properties:
domain:
description: 'Organization web domain or domains; use comma separated list with no spaces for multiple. Example:<br><br>labelstud.io,humansignal.com<br><br>IMPORTANT: DO NOT PUT COMMON DOMAINS LIKE GMAIL.COM, YAHOO.COM, ETC. IN THIS FIELD'
maxLength: 65536
minLength: 3
type: string
mapping_email:
description: 'Mapping attributes: user email from SAML request'
maxLength: 1024
minLength: 1
nullable: true
title: Email
type: string
mapping_first_name:
description: 'Mapping attributes: user first name from SAML request'
maxLength: 1024
nullable: true
title: First name
type: string
mapping_groups:
description: 'Mapping attributes: groups attribute for user mapping to workspaces and roles'
maxLength: 1024
nullable: true
title: Groups
type: string
mapping_last_name:
description: 'Mapping attributes: user last name from SAML request'
maxLength: 1024
nullable: true
title: Last name
type: string
metadata_url:
description: URL SAML metadata from IdP
maxLength: 65536
type: string
metadata_xml:
description: Metadata XML file
type: string
projects_groups:
items:
$ref: '#/components/schemas/ProjectGroupRequest'
Expand Down Expand Up @@ -34906,6 +35214,9 @@ components:
created_by:
readOnly: true
type: integer
created_by_user:
readOnly: true
type: string
description:
description: Workspace description
nullable: true
Expand Down Expand Up @@ -34934,6 +35245,7 @@ components:
type: string
required:
- created_by
- created_by_user
- id
- membership
- projects_count
Expand Down