package mgmt.v1beta
Get desktop application:
View/edit binary Protocol Buffers messages
Mgmt service responds to internal access
Check if a namespace is in use Returns the availability of a namespace or, alternatively, the type of resource that is using it.
message
mgmt.proto:481CheckNamespaceAdminRequest represents a request to verify if a namespace is available.
string id = 1
The namespace ID to be checked.
message
mgmt.proto:488CheckNamespaceAdminResponse contains the availability of a namespace or the type of resource that's using it.
CheckNamespaceAdminResponse.Namespace type = 1
Namespace type.
string uid = 2
Namespace UID.
oneof owner
The owner, which can be either a User or an Organization.
user = 3
User.
organization = 4
Organization.
Check if a namespace is in use by UID Returns the availability of a namespace or, alternatively, the type of resource that is using it.
message
mgmt.proto:518CheckNamespaceByUIDAdminRequest represents a request to verify if a namespace is available.
string uid = 1
The namespace UID to be checked.
message
mgmt.proto:525CheckNamespaceByUIDAdminResponse contains the availability of a namespace or the type of resource that's using it.
CheckNamespaceByUIDAdminResponse.Namespace type = 1
Namespace type.
string id = 2
Namespace ID.
oneof owner
The owner, which can be either a User or an Organization.
user = 3
User.
organization = 4
Organization.
GetOrganizationAdmin method receives a GetOrganizationAdminRequest message and returns a GetOrganizationAdminResponse message.
message
mgmt.proto:348GetOrganizationAdminRequest represents a request to query an organization by admin. Follows AIP-131: https://google.aip.dev/131
string name = 1
The resource name of the organization. Format: `organizations/{organization}`
optional View view = 2
View allows clients to specify the desired resource view in the response.
message
mgmt.proto:357GetOrganizationAdminResponse represents a response for an organization resource
optional organization = 1
An organization resource
GetUserAdmin method receives a GetUserAdminRequest message and returns a GetUserAdminResponse message.
message
mgmt.proto:291GetUserAdminRequest represents a request to query a user by admin. Follows AIP-131: https://google.aip.dev/131
string name = 1
The resource name of the user. Format: `users/{user}`
optional View view = 2
View allows clients to specify the desired resource view in the response.
message
mgmt.proto:300GetUserAdminResponse represents a response for a user resource
optional user = 1
A user resource
ListOrganizationsAdmin method receives a ListOrganizationsAdminRequest message and returns a ListOrganizationsAdminResponse message.
message
mgmt.proto:321ListOrganizationsAdminRequest represents a request to list all organizations by admin
optional int32 page_size = 1
The maximum number of organizations to return. If this parameter is unspecified, at most 10 pipelines will be returned. The cap value for this parameter is 100 (i.e. any value above that will be coerced to 100).
optional string page_token = 2
Page token.
optional View view = 3
View allows clients to specify the desired resource view in the response.
optional string filter = 4
Filter can hold an [AIP-160](https://google.aip.dev/160)-compliant filter expression. - Example: `create_time>timestamp("2000-06-19T23:31:08.657Z")`.
message
mgmt.proto:337ListOrganizationsAdminResponse represents a response for a list of organizations
repeated organizations = 1
A list of organizations
string next_page_token = 2
Next page token.
int32 total_size = 3
Total number of organizations.
ListUsersAdmin method receives a ListUsersAdminRequest message and returns a ListUsersAdminResponse message.
message
mgmt.proto:264ListUsersAdminRequest represents a request to list all users by admin
optional int32 page_size = 1
The maximum number of users to return. If this parameter is unspecified, at most 10 pipelines will be returned. The cap value for this parameter is 100 (i.e. any value above that will be coerced to 100).
optional string page_token = 2
Page token.
optional View view = 3
View allows clients to specify the desired resource view in the response.
optional string filter = 4
Filter can hold an [AIP-160](https://google.aip.dev/160)-compliant filter expression. - Example: `create_time>timestamp("2000-06-19T23:31:08.657Z")`.
message
mgmt.proto:280ListUsersAdminResponse represents a response for a list of users
repeated users = 1
A list of users
string next_page_token = 2
Next page token.
int32 total_size = 3
Total number of users.
LookUpOrganizationAdmin method receives a LookUpOrganizationAdminRequest message and returns a LookUpOrganizationAdminResponse
message
mgmt.proto:364LookUpOrganizationAdminRequest represents a request to query an organization via permalink by admin
optional View view = 2
View allows clients to specify the desired resource view in the response.
string organization_uid = 3
Organization UID
message
mgmt.proto:374LookUpOrganizationAdminResponse represents a response for an organization resource by admin
optional organization = 1
An organization resource
LookUpUserAdmin method receives a LookUpUserAdminRequest message and returns a LookUpUserAdminResponse
message
mgmt.proto:307LookUpUserAdminRequest represents a request to query a user via permalink by admin.
string permalink = 1
The permalink of the user. Format: `users/{user.uid}`
optional View view = 2
View allows clients to specify the desired resource view in the response.
message
mgmt.proto:315LookUpUserAdminResponse represents a response for a user resource by admin
optional user = 1
A user resource
MGMT MgmtPublicService exposes the public Core endpoints that allow clients to manage user resources.
Change password Updates the password of a user.
message
mgmt.proto:729AuthChangePasswordRequest represents a request to update a user's password.
string old_password = 1
Old password.
string new_password = 2
New password.
message
mgmt.proto:737AuthChangePasswordResponse is an empty response.
(message has no fields)
Log in a user Authenticates a user and returns an access token.
message
mgmt.proto:703AuthLoginRequest represents a request for user login.
string username = 1
Username.
string password = 2
Password.
message
mgmt.proto:711AuthLoginResponse contains the access token of the authenticated user.
string access_token = 1
User access token.
Log out a user Logs out an authenticated user.
message
mgmt.proto:717AuthLogoutRequest represents a request for user logout.
(message has no fields)
message
mgmt.proto:720AuthLogoutResponse is an empty response.
(message has no fields)
Get Auth token issuer Returns the auth token issuer details. This operation requires admin permissions.
message
mgmt.proto:675AuthTokenIssuerRequest represents a request to fetch the issuer details of a token.
string username = 1
Username.
string password = 2
Password.
message
mgmt.proto:683AuthTokenIssuerResponse contains the token issuer details.
optional access_token = 1
Access token information.
Validate an access token Checks the validity of an access token.
message
mgmt.proto:723AuthValidateAccessTokenRequest represents a request for access token validation.
(message has no fields)
message
mgmt.proto:726AuthValidateAccessTokenResponse is an empty response.
(message has no fields)
Check if a namespace is in use Returns the availability of a namespace or, alternatively, the type of resource that is using it.
message
mgmt.proto:453CheckNamespaceRequest represents a request to verify if a namespace is available.
string id = 1
The namespace ID to be checked.
message
mgmt.proto:460CheckNamespaceResponse contains the availability of a namespace or the type of resource that's using it.
CheckNamespaceResponse.Namespace type = 1
Namespace type.
Create an API token Creates an API token for the authenticated user.
message
mgmt.proto:608CreateTokenRequest represents a request to create an API token.
optional token = 1
The properties of the token to be created.
message
mgmt.proto:614CreateTokenResponse contains the created token.
optional token = 1
The created API token resource.
Delete an API token Deletes an API token.
message
mgmt.proto:655DeleteTokenRequest represents a request to delete an API token resource. Follows AIP-135: https://google.aip.dev/135
string name = 1
The resource name of the token to delete. Format: `tokens/{token}`
message
mgmt.proto:662DeleteTokenResponse is an empty response.
(message has no fields)
Get the authenticated user Returns the details of the authenticated user.
message
mgmt.proto:424GetAuthenticatedUserRequest represents a request to get the authenticated user.
(message has no fields)
message
mgmt.proto:427GetAuthenticatedUserResponse contains the requested authenticated user.
optional user = 1
The authenticated user resource.
Get model trigger count Returns the model trigger count of a given requester within a timespan. Results are grouped by trigger status.
message
metric.proto:61GetModelTriggerCountRequest represents a request to fetch the trigger count of a requester over a time period.
string requester_id = 1
The ID of the requester that triggered the model.
optional start = 2
Beginning of the time range from which the records will be fetched. The default value is the beginning of the current day, in UTC.
optional stop = 3
End of the time range from which the records will be fetched. The default value is the current timestamp.
message
metric.proto:74GetModelTriggerCountResponse contains the trigger count, grouped by trigger status.
repeated model_trigger_counts = 1
The trigger counts, grouped by status.
Get pipeline trigger count Returns the pipeline trigger count of a given requester within a timespan. Results are grouped by trigger status.
message
metric.proto:41GetPipelineTriggerCountRequest represents a request to fetch the trigger count of a requester over a time period.
string requester_id = 1
The ID of the namespace that requested the pipeline triggers.
optional start = 2
Beginning of the time range from which the records will be fetched. The default value is the beginning of the current day, in UTC.
optional stop = 3
End of the time range from which the records will be fetched. The default value is the current timestamp.
message
metric.proto:54GetPipelineTriggerCountResponse contains the trigger count, grouped by trigger status.
repeated pipeline_trigger_counts = 1
The trigger counts, grouped by status.
Get an API token Returns the details of an API token.
message
mgmt.proto:641GetTokenRequest represents a request to fetch the details of an API token. Follows AIP-131: https://google.aip.dev/131
string name = 1
The resource name of the token. Format: `tokens/{token}`
message
mgmt.proto:648GetTokenResponse contains the requested token.
optional token = 1
The API token resource.
rpc GetUser (, )
mgmt_public_service.proto:96Get a user Returns the details of a user by their ID.
message
mgmt.proto:407GetUserRequest represents a request to fetch the details of a user. Follows AIP-131: https://google.aip.dev/131
string name = 1
The resource name of the user. Format: `users/{user}`
optional View view = 2
View allows clients to specify the desired resource view in the response.
message
mgmt.proto:417GetUserResponse contains the requested user.
optional user = 1
The user resource.
List model trigger time charts Returns a timeline of model trigger counts for a given requester. The response will contain one set of records (datapoints), representing the amount of triggers in a time bucket.
message
metric.proto:137ListModelTriggerChartRecordsRequest represents a request to list model trigger metrics, aggregated by model ID and time frame.
string requester_id = 1
The ID of the namespace that requested the model triggers.
optional string aggregation_window = 2
Aggregation window. The value is a positive duration string, i.e. a sequence of decimal numbers, each with optional fraction and a unit suffix, such as "300ms", "1.5h" or "2h45m". The minimum (and default) window is 1h.
optional start = 3
Beginning of the time range from which the records will be fetched. The default value is the beginning of the current day, in UTC.
optional stop = 4
End of the time range from which the records will be fetched. The default value is the current timestamp.
message
metric.proto:155ListModelTriggerChartRecordsResponse contains a list of model trigger chart records.
repeated model_trigger_chart_records = 1
Model trigger counts. Until we allow filtering or grouping by fields like model ID, this list will contain only one element with the timeline of trigger counts for a given requester, regardless the model ID, trigger mode, final status or other fields.
List pipeline trigger time charts Returns a timeline of pipeline trigger counts for a given requester. The response will contain one set of records (datapoints), representing the amount of triggers in a time bucket.
message
metric.proto:95ListPipelineTriggerChartRecordsRequest represents a request to list pipeline trigger chart records for a given requester, grouped by time buckets.
string requester_id = 1
The ID of the namespace that requested the pipeline triggers.
optional string aggregation_window = 2
Aggregation window. The value is a positive duration string, i.e. a sequence of decimal numbers, each with optional fraction and a unit suffix, such as "300ms", "1.5h" or "2h45m". The minimum (and default) window is 1h.
optional start = 3
Beginning of the time range from which the records will be fetched. The default value is the beginning of the current day, in UTC.
optional stop = 4
End of the time range from which the records will be fetched. The default value is the current timestamp.
message
metric.proto:113ListPipelineTriggerChartRecordsResponse contains a list of pipeline trigger chart records.
repeated pipeline_trigger_chart_records = 1
Pipeline trigger counts. Until we allow filtering or grouping by fields like pipeline ID, this list will contain only one element with the timeline of trigger counts for a given requester, regardless the pipeline ID, trigger mode, final status or other fields.
List pipeline trigger time charts Returns a timeline of pipeline trigger counts for the pipelines of a given owner. NOTE: This method will soon be retired and replaced by ListPipelineTriggerChartRecords.
message
metric.proto:211ListPipelineTriggerChartRecordsV0Request represents a request to list pipeline trigger metrics, aggregated by pipeline ID and time frame.
int32 aggregation_window = 1
Aggregation window in nanoseconds.
optional string filter = 2
Filter can hold an [AIP-160](https://google.aip.dev/160)-compliant filter expression. - Example: `create_time>timestamp("2000-06-19T23:31:08.657Z")`.
message
metric.proto:222ListPipelineTriggerChartRecordsV0Response contains a list of pipeline trigger chart records.
repeated pipeline_trigger_chart_records = 1
A list of pipeline trigger records.
List pipeline triggers Returns a paginated list of pipeline executions. NOTE: This method is deprecated and will be retired soon.
message
metric.proto:274ListPipelineTriggerRecordsRequest represents a request to list the triggers of a pipeline.
optional int32 page_size = 1
The maximum number of triggers to return. If this parameter is unspecified, at most 100 triggers will be returned. The cap value for this parameter is 1000 (i.e. any value above that will be coerced to 1000).
optional string page_token = 2
Page token.
optional string filter = 3
Filter can hold an [AIP-160](https://google.aip.dev/160)-compliant filter expression. - Example: `create_time>timestamp("2000-06-19T23:31:08.657Z")`.
message
metric.proto:288ListPipelineTriggerRecordsResponse contains a list of pipeline triggers.
repeated pipeline_trigger_records = 1
A list of pipeline triggers.
string next_page_token = 2
Next page token.
int32 total_size = 3
Total number of pipeline triggers.
List pipeline trigger metrics Returns a paginated list of pipeline executions aggregated by pipeline ID. NOTE: This method is deprecated and will be retired soon.
message
metric.proto:186ListPipelineTriggerTableRecordsRequest represents a request to list the pipeline triggers metrics, aggregated by pipeline ID.
optional int32 page_size = 1
The maximum number of results to return. If this parameter is unspecified, at most 100 pipelines will be returned. The cap value for this parameter is 1000 (i.e. any value above that will be coerced to 1000).
optional string page_token = 2
Page token.
optional string filter = 3
Filter can hold an [AIP-160](https://google.aip.dev/160)-compliant filter expression. - Example: `create_time>timestamp("2000-06-19T23:31:08.657Z")`.
message
metric.proto:200ListPipelineTriggerTableRecordsResponse contains the pipeline metrics.
repeated pipeline_trigger_table_records = 1
A list of pipeline trigger tables.
string next_page_token = 2
Next page token.
int32 total_size = 3
Total number of pipeline trigger records
List API tokens Returns a paginated list of the API tokens of the authenticated user.
message
mgmt.proto:620ListTokensRequest represents a request to list the API tokens of a user.
optional int32 page_size = 1
The maximum number of tokens to return. If this parameter is unspecified, at most 10 pipelines will be returned. The cap value for this parameter is 100 (i.e. any value above that will be coerced to 100).
optional string page_token = 2
Page token.
message
mgmt.proto:630ListTokensResponse contains a list of API tokens.
repeated tokens = 1
A list of API token resources.
string next_page_token = 2
Next page token.
int32 total_size = 3
Total number of API token resources.
List users Returns a paginated list of users.
message
mgmt.proto:380ListUsersRequest represents a request to list all users.
optional int32 page_size = 1
The maximum number of users to return. If this parameter is unspecified, at most 10 pipelines will be returned. The cap value for this parameter is 100 (i.e. any value above that will be coerced to 100).
optional string page_token = 2
Page token.
optional View view = 3
View allows clients to specify the desired resource view in the response.
optional string filter = 4
Filter can hold an [AIP-160](https://google.aip.dev/160)-compliant filter expression. - Example: `create_time>timestamp("2000-06-19T23:31:08.657Z")`.
message
mgmt.proto:396ListUsersResponse contains a list of users.
repeated users = 1
A list of user resources.
string next_page_token = 2
Next page token.
int32 total_size = 3
Total number of users.
rpc Liveness (, )
mgmt_public_service.proto:24Check if the MGMT server is alive See https://github.com/grpc/grpc/blob/master/doc/health-checking.md.
message
mgmt.proto:17LivenessRequest represents a request to check a service liveness status
optional health_check_request = 1
HealthCheckRequest message
message
mgmt.proto:23LivenessResponse represents a response for a service liveness status
optional health_check_response = 1
HealthCheckResponse message
Update the authenticated user Updates the information of the authenticated user. In REST requests, only the supplied user fields will be taken into account when updating the resource.
message
mgmt.proto:434PatchAuthenticatedUserRequest represents a request to update the authenticated user.
optional user = 1
The user fields that will replace the existing ones.
optional update_mask = 2
The update mask specifies the subset of fields that should be modified. For more information about this field, see https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#field-mask.
message
mgmt.proto:446PatchAuthenticatedUserResponse contains the updated user. the authenticated user resource
optional user = 1
The updated user resource.
Check if the pipeline server is ready See https://github.com/grpc/grpc/blob/master/doc/health-checking.md
message
mgmt.proto:29ReadinessRequest represents a request to check a service readiness status
optional health_check_request = 1
HealthCheckRequest message
message
mgmt.proto:35ReadinessResponse represents a response for a service readiness status
optional health_check_response = 1
HealthCheckResponse message
Validate an API token Validates an API token.
message
mgmt.proto:665ValidateTokenRequest represents a request to validate a token.
(message has no fields)
message
mgmt.proto:668ValidateTokenResponse contains the validation of a token.
string user_uid = 1
If token is valid, UUID of the user that owns it.
message
mgmt.proto:554API tokens allow users to make requests to the Instill AI API.
Used in: , , ,
optional last_use_time = 6
When users trigger a pipeline which uses an API token, the token is updated with the current time. This field is used to track the last time the token was used.
string name = 1
The name of the token, define by its ID. - Format: `tokens/{token.id}`.
string uid = 2
API token UUID.
string id = 3
API token resource ID (used in `name` as the last segment). This conforms to RFC-1034, which restricts to letters, numbers, and hyphen, with the first character a letter, the last a letter or a number, and a 63 character maximum. This field can reflect the client(s) that will use the token.
optional create_time = 4
Creation time.
optional update_time = 5
Update time.
string access_token = 7
An opaque access token representing the API token string. To validate the token, the recipient of the token needs to call the server that issued the token.
ApiToken.State state = 8
State.
string token_type = 9
Token type. Value is fixed to "Bearer".
oneof expiration
Expiration.
int32 ttl = 10
The time-to-live in seconds for this resource.
expire_time = 11
Expiration time.
State describes the state of an API token.
Used in:
STATE_UNSPECIFIED = 0
Unspecified.
STATE_INACTIVE = 1
Inactive.
STATE_ACTIVE = 2
Active.
STATE_EXPIRED = 3
Expired.
message
mgmt.proto:685UnsignedAccessToken contains the token issuer information.
Used in:
string aud = 1
Audience.
string iss = 2
Issuer.
string sub = 3
Subject.
string jti = 4
Unique identifier of the user.
int32 exp = 5
Expiration date.
message
mgmt.proto:137AuthenticatedUser contains the information of an authenticated user, i.e., the public user information plus some fields that should only be accessed by the user themselves. AIP Standard Field Ordering: - name (field 1): Canonical resource name - id (field 2): Immutable canonical resource ID - display_name (field 3): Human-readable display name - slug (field 4): URL-friendly slug - aliases (field 5): Previous slugs for backward compatibility - description (field 6): Optional description - create_time (field 7): Creation timestamp - update_time (field 8): Update timestamp
Used in: , ,
string name = 1
Field 1: Canonical resource name. Format: `users/{user.id}`.
string id = 2
Field 2: Resource ID (used in `name` as the last segment). This conforms to RFC-1034, which restricts to letters, numbers, and hyphen, with the first character a letter, the last a letter or a number, and a 63 character maximum.
string display_name = 3
Field 3: Human-readable display name for UI.
string slug = 4
Field 4: URL-friendly slug (NO prefix).
repeated string aliases = 5
Field 5: Previous slugs for backward compatibility.
string description = 6
Field 6: Optional description / bio.
optional create_time = 7
Field 7: Creation time.
optional update_time = 8
Field 8: Update time.
string email = 9
Email.
optional string role = 12
Role. It must be one of the following allowed roles: - `manager` - `ai-researcher` - `ai-engineer` - `data-engineer` - `data-scientist` - `analytics-engineer` - `hobbyist`
bool newsletter_subscription = 13
This defines whether the user is subscribed to Instill AI's newsletter.
optional string cookie_token = 14
Console cookie token.
OnboardingStatus onboarding_status = 17
Onboarding Status.
optional profile = 18
Profile.
bool is_eligible_for_organization_trial = 19
Is eligible for organization trial.
Namespace contains information about the availability of a namespace.
Used in:
NAMESPACE_UNSPECIFIED = 0
Unspecified.
NAMESPACE_AVAILABLE = 1
Available.
NAMESPACE_USER = 2
Namespace belongs to a user.
NAMESPACE_ORGANIZATION = 3
Namespace belongs to an organization.
NAMESPACE_RESERVED = 4
Reserved.
Namespace contains information about the availability of a namespace.
Used in:
NAMESPACE_UNSPECIFIED = 0
Unspecified.
NAMESPACE_AVAILABLE = 1
Available.
NAMESPACE_USER = 2
Namespace belongs to a user.
NAMESPACE_ORGANIZATION = 3
Namespace belongs to an organization.
NAMESPACE_RESERVED = 4
Reserved.
Namespace contains information about the availability of a namespace.
Used in:
NAMESPACE_UNSPECIFIED = 0
Unspecified.
NAMESPACE_AVAILABLE = 1
Available.
NAMESPACE_USER = 2
Namespace belongs to a user.
NAMESPACE_ORGANIZATION = 3
Namespace belongs to an organization.
NAMESPACE_RESERVED = 4
Reserved.
message
mgmt.proto:834CreateOrganizationRequest represents a request to create an organization.
optional organization = 1
The properties of the organization to be created.
message
mgmt.proto:840CreateOrganizationResponse contains the created organization.
optional organization = 1
The organization resource.
message
mgmt.proto:1057DeleteOrganizationMembershipRequest represents a request to delete an organization membership. Follows AIP-135: https://google.aip.dev/135
string name = 1
The resource name of the membership to delete. Format: `organizations/{organization}/memberships/{user}`
message
mgmt.proto:1064DeleteOrganizationMembershipResponse is an empty response.
(message has no fields)
message
mgmt.proto:883DeleteOrganizationRequest represents a request to delete an organization. Follows AIP-135: https://google.aip.dev/135
string name = 1
The resource name of the organization to delete. Format: `organizations/{organization}`
message
mgmt.proto:890DeleteOrganizationResponse is an empty response.
(message has no fields)
message
mgmt.proto:991DeleteUserMembershipRequest represents a request to delete a user membership. Follows AIP-135: https://google.aip.dev/135
string name = 1
The resource name of the membership to delete. Format: `users/{user}/memberships/{organization}`
message
mgmt.proto:998DeleteUserMembershipResponse is an empty response.
(message has no fields)
message
mgmt.proto:1019GetOrganizationMembershipRequest represents a request to query a user's membership to an organization. Follows AIP-131: https://google.aip.dev/131
string name = 1
The resource name of the membership. Format: `organizations/{organization}/memberships/{user}`
optional View view = 2
View allows clients to specify the desired resource view in the response.
message
mgmt.proto:1029GetOrganizationMembershipResponse contains the organization membership.
optional membership = 1
The requested organization membership.
message
mgmt.proto:848GetOrganizationRequest represents a request to fetch the details of an organization. Follows AIP-131: https://google.aip.dev/131
string name = 1
The resource name of the organization. Format: `organizations/{organization}`
optional View view = 2
View allows clients to specify the desired resource view in the response.
message
mgmt.proto:857GetOrganizationResponse contains the requested organization.
optional organization = 1
The organization resource.
message
mgmt.proto:955GetUserMembershipRequest represents a request to query a user's membership. Follows AIP-131: https://google.aip.dev/131
string name = 1
The resource name of the membership. Format: `users/{user}/memberships/{organization}`
optional View view = 2
View allows clients to specify the desired resource view in the response.
message
mgmt.proto:964GetUserMembershipResponse contains the user membership.
optional membership = 1
The requested user membership.
message
mgmt.proto:1003ListOrganizationMembershipsRequest represents a request to list the memberships of an organization. Follows AIP-132: https://google.aip.dev/132
string parent = 1
The parent resource name (organization). Format: `organizations/{organization}`
message
mgmt.proto:1010ListOrganizationMembershipsResponse contains a list of memberships.
repeated memberships = 1
The organization memberships, i.e., the users that belong to the organization.
message
mgmt.proto:808ListOrganizationsRequest represents a request to list all organizations
optional int32 page_size = 1
The maximum number of organizations to return. If this parameter is unspecified, at most 10 pipelines will be returned. The cap value for this parameter is 100 (i.e. any value above that will be coerced to 100).
optional string page_token = 2
Page token.
optional View view = 3
View allows clients to specify the desired resource view in the response.
optional string filter = 4
Filter can hold an [AIP-160](https://google.aip.dev/160)-compliant filter expression. - Example: `create_time>timestamp("2000-06-19T23:31:08.657Z")`.
message
mgmt.proto:824ListOrganizationsResponse represents a response for a list of organizations
repeated organizations = 1
A list of organizations
string next_page_token = 2
Next page token.
int32 total_size = 3
Total number of organizations.
message
mgmt.proto:941ListUserMembershipsRequest represents a request to list the memberships of a user. Follows AIP-132: https://google.aip.dev/132
string parent = 1
The parent resource name (user). Format: `users/{user}`
message
mgmt.proto:948ListUserMembershipsResponse contains a list of memberships.
repeated memberships = 1
The user memberships, i.e., the organizations the user belongs to.
MembershipState describes the state of a user membership to an organization.
Used in: ,
MEMBERSHIP_STATE_UNSPECIFIED = 0
Unspecified.
MEMBERSHIP_STATE_ACTIVE = 1
Active.
MEMBERSHIP_STATE_PENDING = 2
Pending, i.e., a request has been sent to the user to join an organization.
enum Mode
metric.proto:11Mode describes the execution mode of the pipeline (sync or async).
Used in: ,
MODE_UNSPECIFIED = 0
Unspecified.
MODE_SYNC = 1
Synchronous (result is returned in the response).
MODE_ASYNC = 2
Asynchronous (response only contains acknowledgement).
message
metric.proto:124ModelTriggerChartRecord represents a timeline of model triggers. It contains a collection of (timestamp, count) pairs that represent the total model triggers in a given time bucket.
Used in:
optional string model_id = 1
This field will be present when the information is grouped by model.
repeated time_buckets = 2
Time buckets.
repeated int32 trigger_counts = 3
Aggregated trigger count in each time bucket.
string requester_id = 4
The ID of the namespace that requested the model triggers.
OnboardingStatus describes the status of the user onboarding process.
Used in:
ONBOARDING_STATUS_UNSPECIFIED = 0
Unspecified.
ONBOARDING_STATUS_IN_PROGRESS = 1
In progress, i.e., the user has initiated the onboarding process but has not yet completed it.
ONBOARDING_STATUS_COMPLETED = 2
Completed.
message
mgmt.proto:753Organizations group several users. As entities, they can own resources such as pipelines or releases. Organization represents a group of users working together. AIP Standard Field Ordering: - name (field 1): Canonical resource name - id (field 2): Immutable canonical resource ID - display_name (field 3): Human-readable display name - slug (field 4): URL-friendly slug - aliases (field 5): Previous slugs for backward compatibility - description (field 6): Optional description - create_time (field 7): Creation timestamp - update_time (field 8): Update timestamp - owner (field 9): Owner reference (string, not embedded object)
Used in: , , , , , , , , , , , , ,
string name = 1
Field 1: Canonical resource name. Format: `organizations/{organization.id}`. Example: "organizations/acme-corp"
string id = 2
Field 2: Resource ID (used in `name` as the last segment). This conforms to RFC-1034, which restricts to letters, numbers, and hyphen, with the first character a letter, the last a letter or a number, and a 63 character maximum.
string display_name = 3
Field 3: Human-readable display name for UI. This is copied from profile.display_name for convenience.
string slug = 4
Field 4: URL-friendly slug (NO prefix). Derived from display_name, used for human-friendly URLs.
repeated string aliases = 5
Field 5: Previous slugs for backward compatibility.
string description = 6
Field 6: Optional description / bio.
optional create_time = 7
Field 7: Creation time.
optional update_time = 8
Field 8: Update time.
string owner = 9
Field 9: Owner reference (the user that owns the organization). Format: `users/{user.id}`.
optional profile = 12
Profile containing additional organization information.
optional permission = 13
Permission
optional stats = 14
The organization stats.
message
mgmt.proto:798The Organization stats.
Used in:
int32 user_count = 1
The number of users in the organization.
message
mgmt.proto:894An organization membership defines the relationship between an organization and a user that is attached to it.
Used in: , , ,
string name = 1
The resource name of the membership, which allows its access by organization and user ID. - Format: `organizations/{organization.id}/memberships/{user.id}`.
string role = 3
Role of the user in the organization.
MembershipState state = 4
State of the membership.
optional user = 5
User information.
optional organization = 6
Organization information.
message
mgmt.proto:109OrganizationProfile describes the public data of an organization.
Used in:
string display_name = 1
Display name. Required, human-readable name for UI display. Example: "Instill AI" for organization ID "instill-ai"
optional string bio = 2
Biography.
optional string avatar = 3
Avatar in base64 format.
optional string public_email = 4
Public email.
map<string, string> social_profile_links = 5
Social profile links list the links to the organization's social profiles. The key represents the provider, and the value is the corresponding URL.
message
mgmt.proto:198Owner is a wrapper for User and Organization, used to embed owner information in other resources.
Used in:
oneof owner
The owner, which can be either a User or an Organization.
user = 1
User.
organization = 2
Organization.
OwnerType enumerates the owner type of any resource
OWNER_TYPE_UNSPECIFIED = 0
OwnerType: UNSPECIFIED
OWNER_TYPE_USER = 1
OwnerType: USER
OWNER_TYPE_ORGANIZATION = 2
OwnerType: ORGANIZATION
message
mgmt.proto:63Permission defines how a resource can be used.
Used in:
bool can_edit = 1
Defines whether the resource can be modified.
message
metric.proto:82PipelineTriggerChartRecord represents a timeline of pipeline triggers. It contains a collection of (timestamp, count) pairs that represent the total pipeline triggers in a given time bucket.
Used in:
optional string pipeline_id = 1
This field will be present when the information is grouped by pipeline.
repeated time_buckets = 2
Time buckets.
repeated int32 trigger_counts = 3
Aggregated trigger count in each time bucket.
string requester_id = 4
The ID of the namespace that requested the pipeline triggers.
message
metric.proto:229PipelineTriggerChartRecordV0 contains pipeline trigger metrics, aggregated by pipeline ID and time frame.
Used in:
string pipeline_id = 1
Pipeline ID.
string pipeline_uid = 2
Pipeline UUID.
Mode trigger_mode = 3
Trigger mode.
Status status = 4
Final status.
repeated time_buckets = 5
Time buckets.
repeated int32 trigger_counts = 6
Aggregated trigger count in each time bucket.
repeated float compute_time_duration = 7
Total computation time duration in each time bucket.
string pipeline_release_id = 8
Version for the triggered pipeline if it is a release pipeline.
string pipeline_release_uid = 9
Release UUID for the triggered pipeline if it is a release pipeline.
message
metric.proto:251PipelineTriggerRecord represents a pipeline execution event.
Used in:
optional trigger_time = 1
The moment when the pipeline was triggered.
string pipeline_trigger_id = 2
UUID of the trigger.
string pipeline_id = 3
Pipeline ID.
string pipeline_uid = 4
Pipeline UUID.
Mode trigger_mode = 5
Trigger mode.
float compute_time_duration = 6
Total execution duration.
Status status = 7
Final status.
string pipeline_release_id = 8
If a release of the pipeline was triggered, pipeline version.
string pipeline_release_uid = 9
If a release of the pipeline was triggered, release UUID.
message
metric.proto:169PipelineTriggerTableRecord contains pipeline trigger metrics, aggregated by pipeline ID.
Used in:
string pipeline_id = 1
Pipeline ID.
string pipeline_uid = 2
Pipeline UUID.
int32 trigger_count_completed = 3
Number of triggers with `STATUS_COMPLETED`.
int32 trigger_count_errored = 4
Number of triggers with `STATUS_ERRORED`.
string pipeline_release_id = 5
Version for the triggered pipeline if it is a release pipeline.
string pipeline_release_uid = 6
Release UUID for the triggered pipeline if it is a release pipeline.
Status describes the output of an execution.
Used in: , ,
STATUS_UNSPECIFIED = 0
Unspecified.
STATUS_COMPLETED = 1
Successfully completed.
STATUS_ERRORED = 2
Finished with error.
message
metric.proto:32TriggerCount represents a execution count with some aggregation params (e.g. trigger status).
Used in: ,
int32 trigger_count = 1
Number of triggers.
optional Status status = 2
This field will be present when results are grouped by trigger status.
message
mgmt.proto:1037UpdateOrganizationMembershipRequest represents a request to update an organization membership. Follows AIP-134: https://google.aip.dev/134
optional membership = 1
The membership fields to update. The membership's `name` field identifies the resource. Format: `organizations/{organization}/memberships/{user}`
optional update_mask = 2
The update mask specifies the subset of fields that should be modified. For more information about this field, see https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#field-mask.
message
mgmt.proto:1049UpdateOrganizationMembershipResponse contains the updated membership.
optional membership = 1
The updated membership resource.
message
mgmt.proto:864UpdateOrganizationRequest represents a request to update an organization. Follows AIP-134: https://google.aip.dev/134
optional organization = 1
The organization resource to update. The organization's `name` field identifies the resource. Format: `organizations/{organization}`
optional update_mask = 2
The update mask specifies the subset of fields that should be modified. For more information about this field, see https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#field-mask.
message
mgmt.proto:876UpdateOrganizationResponse contains the updated organization.
optional organization = 1
The organization resource.
message
mgmt.proto:971UpdateUserMembershipRequest represents a request to update a user membership. Follows AIP-134: https://google.aip.dev/134
optional membership = 1
The membership fields to update. The membership's `name` field identifies the resource. Format: `users/{user}/memberships/{organization}`
optional update_mask = 2
The update mask specifies the subset of fields that should be modified. For more information about this field, see https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#field-mask.
message
mgmt.proto:983UpdateUserMembershipResponse contains the updated membership.
optional membership = 1
The updated membership resource.
message
mgmt.proto:220User describes an individual that interacts with Instill AI. It doesn't contain any private information about the user. AIP Standard Field Ordering: - name (field 1): Canonical resource name - id (field 2): Immutable canonical resource ID - display_name (field 3): Human-readable display name - slug (field 4): URL-friendly slug - aliases (field 5): Previous slugs for backward compatibility - description (field 6): Optional description - create_time (field 7): Creation timestamp - update_time (field 8): Update timestamp
Used in: , , , , , , , , , ,
string name = 1
Field 1: Canonical resource name. Format: `users/{user.id}`. Example: "users/john-doe"
string id = 2
Field 2: Resource ID (used in `name` as the last segment). This conforms to RFC-1034, which restricts to letters, numbers, and hyphen, with the first character a letter, the last a letter or a number, and a 63 character maximum.
string display_name = 3
Field 3: Human-readable display name for UI. This is copied from profile.display_name for convenience.
string slug = 4
Field 4: URL-friendly slug (NO prefix). Derived from display_name, used for human-friendly URLs.
repeated string aliases = 5
Field 5: Previous slugs for backward compatibility.
string description = 6
Field 6: Optional description / bio.
optional create_time = 7
Field 7: Creation time.
optional update_time = 8
Field 8: Update time.
optional profile = 11
Profile containing additional user information.
string email = 12
Email.
message
mgmt.proto:917A user membership defines the relationship between a user and an organization they belong to.
Used in: , , ,
string name = 1
The resource name of the membership, which allows its access by user and organization ID. - Format: `users/{user.id}/memberships/{organization.id}`.
string role = 3
Role of the user in the organization.
MembershipState state = 4
State of the membership.
optional user = 5
User information.
optional organization = 6
Organization information.
message
mgmt.proto:91UserProfile describes the public data of a user.
Used in: ,
string display_name = 1
Display name. Required, human-readable name for UI display. Example: "Ping-Lin Chang" for user ID "pinglin"
optional string bio = 2
Biography.
optional string avatar = 3
Avatar in base64 format.
optional string public_email = 4
Public email.
optional string company_name = 5
Company name.
map<string, string> social_profile_links = 6
Social profile links list the links to the user's social profiles. The key represents the provider, and the value is the corresponding URL.
enum View
mgmt.proto:43View defines how a resource is presented. It can be used as a parameter in a method request to allow clients to select the amount of information they want in the response.
Used in: , , , , , , , , , , ,
VIEW_UNSPECIFIED = 0
Unspecified, equivalent to BASIC.
VIEW_BASIC = 1
Default view, only includes basic information.
VIEW_FULL = 2
Full representation.