@meshery/schemas 1.3.55 → 1.3.57
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/cloudApi.d.mts +106 -106
- package/dist/cloudApi.d.ts +106 -106
- package/dist/constructs/v1beta1/organization_smtp/OrganizationSmtp.d.ts +12 -12
- package/dist/constructs/v1beta1/organization_smtp/OrganizationSmtpSchema.js +2 -2
- package/dist/constructs/v1beta1/organization_smtp/OrganizationSmtpSchema.mjs +2 -2
- package/dist/constructs/v1beta2/user/User.d.ts +48 -48
- package/dist/constructs/v1beta2/user/UserSchema.js +1 -1
- package/dist/constructs/v1beta2/user/UserSchema.mjs +1 -1
- package/dist/constructs/v1beta3/design/Design.d.ts +112 -112
- package/dist/constructs/v1beta3/design/DesignSchema.js +14 -14
- package/dist/constructs/v1beta3/design/DesignSchema.mjs +14 -14
- package/dist/constructs/v1beta3/user/User.d.ts +8 -8
- package/dist/constructs/v1beta3/user/UserSchema.js +1 -1
- package/dist/constructs/v1beta3/user/UserSchema.mjs +1 -1
- package/dist/index.d.mts +8 -8
- package/dist/index.d.ts +8 -8
- package/dist/mesheryApi.d.mts +32 -32
- package/dist/mesheryApi.d.ts +32 -32
- package/package.json +1 -1
|
@@ -1,2 +1,2 @@
|
|
|
1
|
-
var e={openapi:"3.0.3",info:{title:"User",description:"OpenAPI schema for user management in Meshery Cloud.",version:"v1beta3",contact:{name:"Meshery Maintainers",email:"maintainers@meshery.io",url:"https://meshery.io"},license:{name:"Apache 2.0",url:"https://www.apache.org/licenses/LICENSE-2.0.html"}},security:[{jwt:[]}],tags:[{name:"users",description:"Operations related to users"}],paths:{"/api/users":{get:{"x-internal":["cloud","meshery"],tags:["users"],operationId:"getUsers",summary:"Get public users",description:"Returns the publicly viewable user directory. Records are reduced to the PublicUser projection (username and avatar); personally identifying fields such as email and real names are never served on this unauthenticated path.",security:[],parameters:[{name:"page",in:"query",description:"Get responses by page",schema:{type:"integer",minimum:0}},{name:"pageSize",in:"query",description:"Number of responses to return per page. Canonical camelCase pagination parameter; prefer this over the deprecated all-lowercase `pagesize`.",schema:{type:"integer",minimum:1}},{name:"search",in:"query",description:"Get responses that match search param value",schema:{type:"string"}},{name:"order",in:"query",description:"Get ordered responses",schema:{type:"string"}},{name:"filter",in:"query",description:"Get filtered reponses",schema:{type:"string"}}],responses:{200:{description:"Paginated list of public users",content:{"application/json":{schema:{type:"object",description:"Paginated list of publicly viewable user records",required:["page","pageSize","totalCount","data"],properties:{page:{type:"integer",description:"Current page number of the result set.",minimum:0},pageSize:{type:"integer",description:"Number of items per page.",minimum:1},totalCount:{type:"integer",description:"Total number of items available.",minimum:0},data:{type:"array",items:{type:"object",additionalProperties:false,description:"Publicly viewable projection of User served by the unauthenticated public users directory. Deliberately excludes email, real names, and every other personally identifying or account-internal field.",required:["id"],properties:{id:{description:"Unique identifier for the user","x-go-name":"ID","x-oapi-codegen-extra-tags":{db:"id",json:"id"},type:"string",format:"uuid","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"}},userId:{deprecated:true,description:"Deprecated duplicate of id kept for consumers that predate the retirement of the legacy user_id column; always equals id.","x-go-name":"UserID","x-oapi-codegen-extra-tags":{db:"user_id",json:"userId,omitempty"},type:"string",format:"uuid","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"}},username:{type:"string",maxLength:200,description:"Public username of the user","x-go-type-skip-optional-pointer":true,"x-oapi-codegen-extra-tags":{db:"username",json:"username,omitempty"}},avatarUrl:{type:"string",format:"uri",maxLength:500,description:"URL to user's avatar image","x-go-type-skip-optional-pointer":true,"x-oapi-codegen-extra-tags":{db:"avatar_url",json:"avatarUrl,omitempty"}}}},description:"Public user records for the requested page."}}}}}},400:{description:"Invalid request body or request param",content:{"text/plain":{schema:{type:"string"}}}},401:{description:"Expired JWT token used or insufficient privilege",content:{"text/plain":{schema:{type:"string"}}}},500:{description:"Internal server error",content:{"text/plain":{schema:{type:"string"}}}}}}},"/api/identity/users/search":{get:{"x-internal":["cloud","meshery"],tags:["users"],operationId:"searchUsers",summary:"Search users",description:"Searches user accounts by name, username, or email and returns the SearchableUser collaboration projection. Serves authenticated people-picker flows such as sharing a design with other users. A blank search returns an empty page.",parameters:[{name:"page",in:"query",description:"Get responses by page",schema:{type:"integer",minimum:0}},{name:"pageSize",in:"query",description:"Number of responses to return per page. Canonical camelCase pagination parameter; prefer this over the deprecated all-lowercase `pagesize`.",schema:{type:"integer",minimum:1}},{name:"search",in:"query",description:"Get responses that match search param value",schema:{type:"string"}},{name:"order",in:"query",description:"Get ordered responses",schema:{type:"string"}},{name:"filter",in:"query",description:"Get filtered reponses",schema:{type:"string"}}],responses:{200:{description:"Paginated list of matching users in the searchable projection",content:{"application/json":{schema:{type:"object",description:"Paginated list of users in the searchable collaboration projection",required:["page","pageSize","totalCount","data"],properties:{page:{type:"integer",description:"Current page number of the result set.",minimum:0},pageSize:{type:"integer",description:"Number of items per page.",minimum:1},totalCount:{type:"integer",description:"Total number of items available.",minimum:0},data:{type:"array",items:{type:"object",additionalProperties:false,description:"Minimal collaboration projection of User served by the authenticated user-search endpoints (people-picker flows such as sharing a design). Carries just enough to identify and display a person - name, username, email, avatar - and deliberately excludes roles, organization and team membership, preferences, and login metadata.",required:["id"],properties:{id:{description:"Unique identifier for the user","x-go-name":"ID","x-oapi-codegen-extra-tags":{db:"id",json:"id"},type:"string",format:"uuid","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"}},userId:{deprecated:true,description:"Deprecated duplicate of id kept for consumers that predate the retirement of the legacy user_id column; always equals id.","x-go-name":"UserID","x-oapi-codegen-extra-tags":{db:"user_id",json:"userId,omitempty"},type:"string",format:"uuid","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"}},username:{type:"string",maxLength:200,description:"Public username of the user","x-go-type-skip-optional-pointer":true,"x-oapi-codegen-extra-tags":{db:"username",json:"username,omitempty"}},firstName:{type:"string",maxLength:200,description:"User's first name","x-go-type-skip-optional-pointer":true,"x-oapi-codegen-extra-tags":{db:"first_name",json:"firstName,omitempty"}},lastName:{type:"string",maxLength:300,description:"User's last name","x-go-type-skip-optional-pointer":true,"x-oapi-codegen-extra-tags":{db:"last_name",json:"lastName,omitempty"}},email:{type:"string",format:"email",maxLength:300,description:"User's email address","x-go-type-skip-optional-pointer":true,"x-oapi-codegen-extra-tags":{db:"email",json:"email,omitempty"}},avatarUrl:{type:"string",format:"uri",maxLength:500,description:"URL to user's avatar image","x-go-type-skip-optional-pointer":true,"x-oapi-codegen-extra-tags":{db:"avatar_url",json:"avatarUrl,omitempty"}},deletedAt:{description:"Timestamp when the user record was soft-deleted (null if not deleted)","x-oapi-codegen-extra-tags":{db:"deleted_at",json:"deletedAt,omitempty"},"x-go-type":"meshcore.NullTime","x-go-type-import":{name:"meshcore",path:"github.com/meshery/schemas/models/core"},type:"string",format:"date-time",nullable:true,"x-go-type-skip-optional-pointer":true}}},description:"Matching user records for the requested page."}}}}}},400:{description:"Invalid request body or request param",content:{"text/plain":{schema:{type:"string"}}}},401:{description:"Expired JWT token used or insufficient privilege",content:{"text/plain":{schema:{type:"string"}}}},500:{description:"Internal server error",content:{"text/plain":{schema:{type:"string"}}}}}}},"/api/identity/orgs/{orgId}/users/search":{get:{"x-internal":["cloud"],tags:["users"],operationId:"searchUsersInOrg",summary:"Search users within an organization scope",description:"Searches user accounts on behalf of an organization context and returns the SearchableUser collaboration projection. A blank search returns an empty page.",parameters:[{name:"orgId",in:"path",required:true,description:"Organization ID","x-go-name":"OrgID",schema:{type:"string",format:"uuid"}},{name:"page",in:"query",description:"Get responses by page",schema:{type:"integer",minimum:0}},{name:"pageSize",in:"query",description:"Number of responses to return per page. Canonical camelCase pagination parameter; prefer this over the deprecated all-lowercase `pagesize`.",schema:{type:"integer",minimum:1}},{name:"search",in:"query",description:"Get responses that match search param value",schema:{type:"string"}},{name:"order",in:"query",description:"Get ordered responses",schema:{type:"string"}},{name:"filter",in:"query",description:"Get filtered reponses",schema:{type:"string"}}],responses:{200:{description:"Paginated list of matching users in the searchable projection",content:{"application/json":{schema:{type:"object",description:"Paginated list of users in the searchable collaboration projection",required:["page","pageSize","totalCount","data"],properties:{page:{type:"integer",description:"Current page number of the result set.",minimum:0},pageSize:{type:"integer",description:"Number of items per page.",minimum:1},totalCount:{type:"integer",description:"Total number of items available.",minimum:0},data:{type:"array",items:{type:"object",additionalProperties:false,description:"Minimal collaboration projection of User served by the authenticated user-search endpoints (people-picker flows such as sharing a design). Carries just enough to identify and display a person - name, username, email, avatar - and deliberately excludes roles, organization and team membership, preferences, and login metadata.",required:["id"],properties:{id:{description:"Unique identifier for the user","x-go-name":"ID","x-oapi-codegen-extra-tags":{db:"id",json:"id"},type:"string",format:"uuid","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"}},userId:{deprecated:true,description:"Deprecated duplicate of id kept for consumers that predate the retirement of the legacy user_id column; always equals id.","x-go-name":"UserID","x-oapi-codegen-extra-tags":{db:"user_id",json:"userId,omitempty"},type:"string",format:"uuid","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"}},username:{type:"string",maxLength:200,description:"Public username of the user","x-go-type-skip-optional-pointer":true,"x-oapi-codegen-extra-tags":{db:"username",json:"username,omitempty"}},firstName:{type:"string",maxLength:200,description:"User's first name","x-go-type-skip-optional-pointer":true,"x-oapi-codegen-extra-tags":{db:"first_name",json:"firstName,omitempty"}},lastName:{type:"string",maxLength:300,description:"User's last name","x-go-type-skip-optional-pointer":true,"x-oapi-codegen-extra-tags":{db:"last_name",json:"lastName,omitempty"}},email:{type:"string",format:"email",maxLength:300,description:"User's email address","x-go-type-skip-optional-pointer":true,"x-oapi-codegen-extra-tags":{db:"email",json:"email,omitempty"}},avatarUrl:{type:"string",format:"uri",maxLength:500,description:"URL to user's avatar image","x-go-type-skip-optional-pointer":true,"x-oapi-codegen-extra-tags":{db:"avatar_url",json:"avatarUrl,omitempty"}},deletedAt:{description:"Timestamp when the user record was soft-deleted (null if not deleted)","x-oapi-codegen-extra-tags":{db:"deleted_at",json:"deletedAt,omitempty"},"x-go-type":"meshcore.NullTime","x-go-type-import":{name:"meshcore",path:"github.com/meshery/schemas/models/core"},type:"string",format:"date-time",nullable:true,"x-go-type-skip-optional-pointer":true}}},description:"Matching user records for the requested page."}}}}}},400:{description:"Invalid request body or request param",content:{"text/plain":{schema:{type:"string"}}}},401:{description:"Expired JWT token used or insufficient privilege",content:{"text/plain":{schema:{type:"string"}}}},500:{description:"Internal server error",content:{"text/plain":{schema:{type:"string"}}}}}}}},components:{securitySchemes:{jwt:{type:"http",scheme:"bearer",bearerFormat:"JWT"}},responses:{400:{description:"Invalid request body or request param",content:{"text/plain":{schema:{type:"string"}}}},401:{description:"Expired JWT token used or insufficient privilege",content:{"text/plain":{schema:{type:"string"}}}},404:{description:"Result not found",content:{"text/plain":{schema:{type:"string"}}}},500:{description:"Internal server error",content:{"text/plain":{schema:{type:"string"}}}}},parameters:{orgId:{name:"orgId",in:"path",required:true,description:"Organization ID","x-go-name":"OrgID",schema:{type:"string",format:"uuid"}},page:{name:"page",in:"query",description:"Get responses by page",schema:{type:"integer",minimum:0}},pageSize:{name:"pageSize",in:"query",description:"Number of responses to return per page. Canonical camelCase pagination parameter; prefer this over the deprecated all-lowercase `pagesize`.",schema:{type:"integer",minimum:1}},search:{name:"search",in:"query",description:"Get responses that match search param value",schema:{type:"string"}},order:{name:"order",in:"query",description:"Get ordered responses",schema:{type:"string"}},filter:{name:"filter",in:"query",description:"Get filtered reponses",schema:{type:"string"}}},schemas:{User:{type:"object",description:"Represents a user",required:["id","provider","email","firstName","lastName","status","createdAt","updatedAt","lastLoginTime","deletedAt"],properties:{id:{description:"Unique identifier for the user","x-go-name":"ID","x-oapi-codegen-extra-tags":{db:"id",json:"id"},type:"string",format:"uuid","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"}},provider:{type:"string",maxLength:100,description:"Authentication provider (e.g., Google, Github)",example:["local","github","google","twitter"],"x-oapi-codegen-extra-tags":{db:"provider",json:"provider"}},email:{type:"string",format:"email",maxLength:300,description:"User's email address","x-oapi-codegen-extra-tags":{db:"email",json:"email"}},firstName:{type:"string",maxLength:200,description:"User's first name","x-oapi-codegen-extra-tags":{db:"first_name",json:"firstName"}},lastName:{type:"string",maxLength:300,description:"User's last name","x-oapi-codegen-extra-tags":{db:"last_name",json:"lastName"}},avatarUrl:{type:"string",format:"uri",maxLength:500,description:"URL to user's avatar image","x-oapi-codegen-extra-tags":{db:"avatar_url",json:"avatarUrl"}},status:{type:"string",maxLength:100,enum:["active","inactive","pending","anonymous"],description:"User account status","x-oapi-codegen-extra-tags":{db:"status",json:"status"}},bio:{type:"string",maxLength:1e3,default:"",description:"User's biography or description","x-oapi-codegen-extra-tags":{db:"bio",json:"bio"}},country:{type:"object",description:"User's country information stored as JSONB",additionalProperties:true,"x-go-type":"core.Map","x-go-type-skip-optional-pointer":true,"x-oapi-codegen-extra-tags":{db:"country",json:"country"}},region:{type:"object",description:"User's region information stored as JSONB",additionalProperties:true,"x-go-type":"core.Map","x-go-type-skip-optional-pointer":true,"x-oapi-codegen-extra-tags":{db:"region",json:"region"}},preferences:{"x-go-type":"Preference",description:"User preferences stored as JSONB","x-oapi-codegen-extra-tags":{db:"preferences",json:"preferences"},"x-generate-db-helpers":true,type:"object",required:["anonymousUsageStats","anonymousPerfResults","updatedAt","dashboardPreferences","selectedOrganizationId","selectedWorkspaceForOrganizations","usersExtensionPreferences","remoteProviderPreferences"],properties:{meshAdapters:{type:"array",items:{"x-go-type":"Adapter",type:"object",description:"Placeholder for Adapter struct definition."},description:"The mesh adapters of the preference."},grafana:{"x-go-type":"Grafana",type:"object",properties:{grafanaUrl:{type:"string",description:"Grafana URL for the user configuration.",maxLength:500},grafanaApiKey:{type:"string",description:"Grafana API key for the user configuration.",maxLength:500},selectedBoardsConfigs:{type:"array",items:{type:"object",properties:{board:{type:"object",description:"Placeholder for GrafanaBoard definition (define fields as needed)"},panels:{type:"array",items:{type:"object",description:"Grafana panel structure imported from github.com/grafana-tools/sdk"},description:"Panels selected for the Grafana board configuration."},templateVars:{type:"array",items:{type:"string"},description:"Template variables applied to the selected Grafana board configuration."}}},description:"Selected Grafana board configurations for the user."}}},prometheus:{"x-go-type":"Prometheus",type:"object",properties:{prometheusUrl:{type:"string",description:"The prometheus URL of the prometheus.",maxLength:500},selectedPrometheusBoardsConfigs:{type:"array",items:{type:"object",properties:{board:{type:"object",description:"Placeholder for GrafanaBoard definition (define fields as needed)"},panels:{type:"array",items:{type:"object",description:"Grafana panel structure imported from github.com/grafana-tools/sdk"},description:"Panels selected for the Grafana board configuration."},templateVars:{type:"array",items:{type:"string"},description:"Template variables applied to the selected Grafana board configuration."}}},description:"The selected prometheus boards configs of the prometheus."}}},loadTestPrefs:{"x-go-type":"LoadTestPreferences",type:"object",properties:{c:{type:"integer",description:"Concurrent requests",minimum:0},qps:{type:"integer",description:"Queries per second",minimum:0},t:{type:"string",description:"Duration",maxLength:500},gen:{type:"string",description:"Load generator",maxLength:500}}},anonymousUsageStats:{type:"boolean",description:"The anonymous usage stats of the preference."},anonymousPerfResults:{type:"boolean",description:"The anonymous perf results of the preference."},updatedAt:{type:"string",format:"date-time",description:"Timestamp of when the resource was last updated."},dashboardPreferences:{type:"object",additionalProperties:true,description:"The dashboard preferences of the preference."},selectedOrganizationId:{type:"string",description:"ID of the associated selectedOrganization.",maxLength:500,format:"uuid"},selectedWorkspaceForOrganizations:{type:"object",additionalProperties:{type:"string"},description:"The selected workspace for organizations of the preference."},usersExtensionPreferences:{type:"object",additionalProperties:true,description:"The users extension preferences of the preference."},remoteProviderPreferences:{type:"object",additionalProperties:true,description:"The remote provider preferences of the preference."}}},acceptedTermsAt:{description:"Timestamp when user accepted terms and conditions","x-oapi-codegen-extra-tags":{db:"accepted_terms_at",json:"acceptedTermsAt"},type:"string",format:"date-time","x-go-type-skip-optional-pointer":true},firstLoginTime:{description:"Timestamp of user's first login","x-oapi-codegen-extra-tags":{db:"first_login_time",json:"firstLoginTime"},type:"string",format:"date-time","x-go-type-skip-optional-pointer":true},lastLoginTime:{description:"Timestamp of user's most recent login","x-oapi-codegen-extra-tags":{db:"last_login_time",json:"lastLoginTime"},type:"string",format:"date-time","x-go-type-skip-optional-pointer":true},createdAt:{description:"Timestamp when the user record was created","x-oapi-codegen-extra-tags":{db:"created_at",json:"createdAt"},type:"string",format:"date-time","x-go-type-skip-optional-pointer":true},updatedAt:{description:"Timestamp when the user record was last updated","x-oapi-codegen-extra-tags":{db:"updated_at",json:"updatedAt"},type:"string",format:"date-time","x-go-type-skip-optional-pointer":true},socials:{type:"array",description:"Various online profiles associated with the user account","x-go-type":"UserSocials",items:{"x-go-type":"Social",description:"Various online profiles associated with the user account, like GitHub, LinkedIn, X, and so on.",type:"object",properties:{site:{type:"string",maxLength:50,description:"The site of the social."},link:{type:"string",format:"uri",description:"The link of the social."}},required:["site","link"]},"x-oapi-codegen-extra-tags":{db:"socials",json:"socials"}},deletedAt:{type:"string",format:"date-time",nullable:true,description:"Timestamp when the user record was soft-deleted (null if not deleted)","x-go-type":"core.NullTime","x-oapi-codegen-extra-tags":{db:"deleted_at",json:"deletedAt"}},roleNames:{type:"array","x-go-type":"pq.StringArray","x-go-type-import":{path:"github.com/lib/pq"},"x-go-type-skip-optional-pointer":true,items:{type:"string"},description:'Names of the global roles assigned to the user. Free-form, user-generated values sourced from the roles table (role_name is a varchar, not a fixed enumeration); the seeded system roles such as "admin", "organization admin" and "user" are a subset, not the whole set.',example:["organization admin","user"],"x-oapi-codegen-extra-tags":{db:"role_names",json:"roleNames"}},teams:{type:"object",description:"Teams the user belongs to with role information","x-oapi-codegen-extra-tags":{db:"teams",json:"teams"},properties:{teamsWithRoles:{type:"array",description:"Team memberships for the user with their assigned roles.",items:{type:"object",additionalProperties:false,description:"A team the user is a member of, together with the names of the roles assigned to that user within the team. Returned as an item of User.teams.teamsWithRoles. The role names are dynamic, user-generated values (no fixed enumeration).",required:["id","name","roleNames"],properties:{id:{description:"Unique identifier of the team.","x-go-name":"ID","x-order":1,"x-oapi-codegen-extra-tags":{db:"id",json:"id,omitempty"},type:"string",format:"uuid","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"}},name:{type:"string",description:"Name of the team.","x-order":2,"x-oapi-codegen-extra-tags":{db:"name",json:"name,omitempty"}},description:{type:"string",description:"Human readable description of the team.","x-order":3,"x-oapi-codegen-extra-tags":{db:"description",json:"description,omitempty"}},owner:{description:"Identifier of the team owner.","x-order":4,"x-oapi-codegen-extra-tags":{db:"owner",json:"owner,omitempty"},type:"string",format:"uuid","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"}},metadata:{type:"object",additionalProperties:true,description:"Free-form metadata associated with the team.","x-go-type":"core.Map","x-go-type-skip-optional-pointer":true,"x-order":5,"x-oapi-codegen-extra-tags":{db:"metadata",json:"metadata,omitempty"}},createdAt:{description:"Timestamp when the team was created.","x-order":6,"x-oapi-codegen-extra-tags":{db:"created_at",json:"createdAt,omitempty"},type:"string",format:"date-time","x-go-type-skip-optional-pointer":true},updatedAt:{description:"Timestamp when the team was last updated.","x-order":7,"x-oapi-codegen-extra-tags":{db:"updated_at",json:"updatedAt,omitempty"},type:"string",format:"date-time","x-go-type-skip-optional-pointer":true},deletedAt:{type:"string",format:"date-time",nullable:true,description:"Timestamp when the team was soft-deleted (null if not deleted).","x-go-type":"core.NullTime","x-order":8,"x-oapi-codegen-extra-tags":{db:"deleted_at",json:"deletedAt,omitempty"}},roleNames:{type:"array","x-go-type":"pq.StringArray","x-go-type-import":{path:"github.com/lib/pq"},description:"Names of the roles assigned to the user within this team. Free-form, user-generated role names; not a fixed enumeration.",items:{type:"string"},"x-order":9,"x-oapi-codegen-extra-tags":{db:"role_names",json:"roleNames"}}}},"x-oapi-codegen-extra-tags":{db:"teams_with_roles",json:"teamsWithRoles"}},totalCount:{type:"integer",description:"Total number of team memberships returned for the user.",minimum:0,"x-oapi-codegen-extra-tags":{db:"total_count",json:"totalCount"}}}},organizations:{type:"object",description:"Organizations the user belongs to with role information","x-oapi-codegen-extra-tags":{db:"organizations",json:"organizations"},properties:{organizationsWithRoles:{type:"array",description:"Organization memberships for the user with their assigned roles.",items:{type:"object",additionalProperties:false,description:"An organization the user is a member of, together with the names of the roles assigned to that user within the organization. Returned as an item of User.organizations.organizationsWithRoles. The role names are dynamic, user-generated values (no fixed enumeration).",required:["id","name","roleNames"],properties:{id:{description:"Unique identifier of the organization.","x-go-name":"ID","x-order":1,"x-oapi-codegen-extra-tags":{db:"id",json:"id,omitempty"},type:"string",format:"uuid","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"}},name:{type:"string",description:"Name of the organization.","x-order":2,"x-oapi-codegen-extra-tags":{db:"name",json:"name,omitempty"}},description:{type:"string",description:"Human readable description of the organization.","x-order":3,"x-oapi-codegen-extra-tags":{db:"description",json:"description,omitempty"}},country:{type:"string",description:"Country associated with the organization.","x-order":4,"x-oapi-codegen-extra-tags":{db:"country",json:"country,omitempty"}},region:{type:"string",description:"Region associated with the organization.","x-order":5,"x-oapi-codegen-extra-tags":{db:"region",json:"region,omitempty"}},owner:{description:"Identifier of the organization owner.","x-order":6,"x-oapi-codegen-extra-tags":{db:"owner",json:"owner,omitempty"},type:"string",format:"uuid","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"}},createdAt:{description:"Timestamp when the organization was created.","x-order":7,"x-oapi-codegen-extra-tags":{db:"created_at",json:"createdAt,omitempty"},type:"string",format:"date-time","x-go-type-skip-optional-pointer":true},updatedAt:{description:"Timestamp when the organization was last updated.","x-order":8,"x-oapi-codegen-extra-tags":{db:"updated_at",json:"updatedAt,omitempty"},type:"string",format:"date-time","x-go-type-skip-optional-pointer":true},deletedAt:{type:"string",format:"date-time",nullable:true,description:"Timestamp when the organization was soft-deleted (null if not deleted).","x-go-type":"core.NullTime","x-order":9,"x-oapi-codegen-extra-tags":{db:"deleted_at",json:"deletedAt,omitempty"}},roleNames:{type:"array","x-go-type":"pq.StringArray","x-go-type-import":{path:"github.com/lib/pq"},description:"Names of the roles assigned to the user within this organization. Free-form, user-generated role names; not a fixed enumeration.",items:{type:"string"},"x-order":10,"x-oapi-codegen-extra-tags":{db:"role_names",json:"roleNames"}}}},"x-oapi-codegen-extra-tags":{db:"organizations_with_roles",json:"organizationsWithRoles"}},totalCount:{type:"integer",description:"Total number of organization memberships returned for the user.",minimum:0,"x-oapi-codegen-extra-tags":{db:"total_count",json:"totalCount"}}}}},additionalProperties:false},PublicUser:{type:"object",additionalProperties:false,description:"Publicly viewable projection of User served by the unauthenticated public users directory. Deliberately excludes email, real names, and every other personally identifying or account-internal field.",required:["id"],properties:{id:{description:"Unique identifier for the user","x-go-name":"ID","x-oapi-codegen-extra-tags":{db:"id",json:"id"},type:"string",format:"uuid","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"}},userId:{deprecated:true,description:"Deprecated duplicate of id kept for consumers that predate the retirement of the legacy user_id column; always equals id.","x-go-name":"UserID","x-oapi-codegen-extra-tags":{db:"user_id",json:"userId,omitempty"},type:"string",format:"uuid","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"}},username:{type:"string",maxLength:200,description:"Public username of the user","x-go-type-skip-optional-pointer":true,"x-oapi-codegen-extra-tags":{db:"username",json:"username,omitempty"}},avatarUrl:{type:"string",format:"uri",maxLength:500,description:"URL to user's avatar image","x-go-type-skip-optional-pointer":true,"x-oapi-codegen-extra-tags":{db:"avatar_url",json:"avatarUrl,omitempty"}}}},PublicUsersPage:{type:"object",description:"Paginated list of publicly viewable user records",required:["page","pageSize","totalCount","data"],properties:{page:{type:"integer",description:"Current page number of the result set.",minimum:0},pageSize:{type:"integer",description:"Number of items per page.",minimum:1},totalCount:{type:"integer",description:"Total number of items available.",minimum:0},data:{type:"array",items:{type:"object",additionalProperties:false,description:"Publicly viewable projection of User served by the unauthenticated public users directory. Deliberately excludes email, real names, and every other personally identifying or account-internal field.",required:["id"],properties:{id:{description:"Unique identifier for the user","x-go-name":"ID","x-oapi-codegen-extra-tags":{db:"id",json:"id"},type:"string",format:"uuid","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"}},userId:{deprecated:true,description:"Deprecated duplicate of id kept for consumers that predate the retirement of the legacy user_id column; always equals id.","x-go-name":"UserID","x-oapi-codegen-extra-tags":{db:"user_id",json:"userId,omitempty"},type:"string",format:"uuid","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"}},username:{type:"string",maxLength:200,description:"Public username of the user","x-go-type-skip-optional-pointer":true,"x-oapi-codegen-extra-tags":{db:"username",json:"username,omitempty"}},avatarUrl:{type:"string",format:"uri",maxLength:500,description:"URL to user's avatar image","x-go-type-skip-optional-pointer":true,"x-oapi-codegen-extra-tags":{db:"avatar_url",json:"avatarUrl,omitempty"}}}},description:"Public user records for the requested page."}}},SearchableUser:{type:"object",additionalProperties:false,description:"Minimal collaboration projection of User served by the authenticated user-search endpoints (people-picker flows such as sharing a design). Carries just enough to identify and display a person - name, username, email, avatar - and deliberately excludes roles, organization and team membership, preferences, and login metadata.",required:["id"],properties:{id:{description:"Unique identifier for the user","x-go-name":"ID","x-oapi-codegen-extra-tags":{db:"id",json:"id"},type:"string",format:"uuid","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"}},userId:{deprecated:true,description:"Deprecated duplicate of id kept for consumers that predate the retirement of the legacy user_id column; always equals id.","x-go-name":"UserID","x-oapi-codegen-extra-tags":{db:"user_id",json:"userId,omitempty"},type:"string",format:"uuid","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"}},username:{type:"string",maxLength:200,description:"Public username of the user","x-go-type-skip-optional-pointer":true,"x-oapi-codegen-extra-tags":{db:"username",json:"username,omitempty"}},firstName:{type:"string",maxLength:200,description:"User's first name","x-go-type-skip-optional-pointer":true,"x-oapi-codegen-extra-tags":{db:"first_name",json:"firstName,omitempty"}},lastName:{type:"string",maxLength:300,description:"User's last name","x-go-type-skip-optional-pointer":true,"x-oapi-codegen-extra-tags":{db:"last_name",json:"lastName,omitempty"}},email:{type:"string",format:"email",maxLength:300,description:"User's email address","x-go-type-skip-optional-pointer":true,"x-oapi-codegen-extra-tags":{db:"email",json:"email,omitempty"}},avatarUrl:{type:"string",format:"uri",maxLength:500,description:"URL to user's avatar image","x-go-type-skip-optional-pointer":true,"x-oapi-codegen-extra-tags":{db:"avatar_url",json:"avatarUrl,omitempty"}},deletedAt:{description:"Timestamp when the user record was soft-deleted (null if not deleted)","x-oapi-codegen-extra-tags":{db:"deleted_at",json:"deletedAt,omitempty"},"x-go-type":"meshcore.NullTime","x-go-type-import":{name:"meshcore",path:"github.com/meshery/schemas/models/core"},type:"string",format:"date-time",nullable:true,"x-go-type-skip-optional-pointer":true}}},SearchableUsersPage:{type:"object",description:"Paginated list of users in the searchable collaboration projection",required:["page","pageSize","totalCount","data"],properties:{page:{type:"integer",description:"Current page number of the result set.",minimum:0},pageSize:{type:"integer",description:"Number of items per page.",minimum:1},totalCount:{type:"integer",description:"Total number of items available.",minimum:0},data:{type:"array",items:{type:"object",additionalProperties:false,description:"Minimal collaboration projection of User served by the authenticated user-search endpoints (people-picker flows such as sharing a design). Carries just enough to identify and display a person - name, username, email, avatar - and deliberately excludes roles, organization and team membership, preferences, and login metadata.",required:["id"],properties:{id:{description:"Unique identifier for the user","x-go-name":"ID","x-oapi-codegen-extra-tags":{db:"id",json:"id"},type:"string",format:"uuid","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"}},userId:{deprecated:true,description:"Deprecated duplicate of id kept for consumers that predate the retirement of the legacy user_id column; always equals id.","x-go-name":"UserID","x-oapi-codegen-extra-tags":{db:"user_id",json:"userId,omitempty"},type:"string",format:"uuid","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"}},username:{type:"string",maxLength:200,description:"Public username of the user","x-go-type-skip-optional-pointer":true,"x-oapi-codegen-extra-tags":{db:"username",json:"username,omitempty"}},firstName:{type:"string",maxLength:200,description:"User's first name","x-go-type-skip-optional-pointer":true,"x-oapi-codegen-extra-tags":{db:"first_name",json:"firstName,omitempty"}},lastName:{type:"string",maxLength:300,description:"User's last name","x-go-type-skip-optional-pointer":true,"x-oapi-codegen-extra-tags":{db:"last_name",json:"lastName,omitempty"}},email:{type:"string",format:"email",maxLength:300,description:"User's email address","x-go-type-skip-optional-pointer":true,"x-oapi-codegen-extra-tags":{db:"email",json:"email,omitempty"}},avatarUrl:{type:"string",format:"uri",maxLength:500,description:"URL to user's avatar image","x-go-type-skip-optional-pointer":true,"x-oapi-codegen-extra-tags":{db:"avatar_url",json:"avatarUrl,omitempty"}},deletedAt:{description:"Timestamp when the user record was soft-deleted (null if not deleted)","x-oapi-codegen-extra-tags":{db:"deleted_at",json:"deletedAt,omitempty"},"x-go-type":"meshcore.NullTime","x-go-type-import":{name:"meshcore",path:"github.com/meshery/schemas/models/core"},type:"string",format:"date-time",nullable:true,"x-go-type-skip-optional-pointer":true}}},description:"Matching user records for the requested page."}}},UserEmailAddress:{type:"object",additionalProperties:false,description:"One email address associated with a user account. A user has exactly one primary address (mirrored in users.email) and any number of secondary addresses accumulated from account consolidation or explicit addition. Uniqueness across live addresses is enforced case-insensitively.",required:["id","userId","email","verified","isPrimary","source","createdAt","updatedAt"],properties:{id:{description:"Unique identifier for this email-address record","x-go-name":"ID","x-oapi-codegen-extra-tags":{db:"id",json:"id"},type:"string",format:"uuid","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"}},userId:{description:"The user (users.id) this address belongs to","x-go-name":"UserID","x-oapi-codegen-extra-tags":{db:"owner",json:"userId"},type:"string",format:"uuid","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"}},email:{type:"string",format:"email",maxLength:300,description:"The email address","x-oapi-codegen-extra-tags":{db:"email",json:"email"}},verified:{type:"boolean",default:false,description:"Whether the address was verified (per Kratos verifiable addresses) at record time","x-oapi-codegen-extra-tags":{db:"verified",json:"verified"}},isPrimary:{type:"boolean",default:false,description:"Exactly one live primary address per user; mirrors users.email","x-oapi-codegen-extra-tags":{db:"is_primary",json:"isPrimary"}},source:{type:"string",enum:["signup","consolidation","backfill","manual"],description:"How this address became associated with the account","x-oapi-codegen-extra-tags":{db:"source",json:"source"}},createdAt:{"x-oapi-codegen-extra-tags":{db:"created_at",json:"createdAt"},type:"string",format:"date-time","x-go-type-skip-optional-pointer":true},updatedAt:{"x-oapi-codegen-extra-tags":{db:"updated_at",json:"updatedAt"},type:"string",format:"date-time","x-go-type-skip-optional-pointer":true},deletedAt:{"x-oapi-codegen-extra-tags":{db:"deleted_at",json:"deletedAt"},description:"SQL null Timestamp to handle null values of time.","x-go-type":"meshcore.NullTime","x-go-type-import":{name:"meshcore",path:"github.com/meshery/schemas/models/core"},type:"string",format:"date-time",nullable:true,"x-go-type-skip-optional-pointer":true}}},OrganizationWithRoles:{type:"object",additionalProperties:false,description:"An organization the user is a member of, together with the names of the roles assigned to that user within the organization. Returned as an item of User.organizations.organizationsWithRoles. The role names are dynamic, user-generated values (no fixed enumeration).",required:["id","name","roleNames"],properties:{id:{description:"Unique identifier of the organization.","x-go-name":"ID","x-order":1,"x-oapi-codegen-extra-tags":{db:"id",json:"id,omitempty"},type:"string",format:"uuid","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"}},name:{type:"string",description:"Name of the organization.","x-order":2,"x-oapi-codegen-extra-tags":{db:"name",json:"name,omitempty"}},description:{type:"string",description:"Human readable description of the organization.","x-order":3,"x-oapi-codegen-extra-tags":{db:"description",json:"description,omitempty"}},country:{type:"string",description:"Country associated with the organization.","x-order":4,"x-oapi-codegen-extra-tags":{db:"country",json:"country,omitempty"}},region:{type:"string",description:"Region associated with the organization.","x-order":5,"x-oapi-codegen-extra-tags":{db:"region",json:"region,omitempty"}},owner:{description:"Identifier of the organization owner.","x-order":6,"x-oapi-codegen-extra-tags":{db:"owner",json:"owner,omitempty"},type:"string",format:"uuid","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"}},createdAt:{description:"Timestamp when the organization was created.","x-order":7,"x-oapi-codegen-extra-tags":{db:"created_at",json:"createdAt,omitempty"},type:"string",format:"date-time","x-go-type-skip-optional-pointer":true},updatedAt:{description:"Timestamp when the organization was last updated.","x-order":8,"x-oapi-codegen-extra-tags":{db:"updated_at",json:"updatedAt,omitempty"},type:"string",format:"date-time","x-go-type-skip-optional-pointer":true},deletedAt:{type:"string",format:"date-time",nullable:true,description:"Timestamp when the organization was soft-deleted (null if not deleted).","x-go-type":"core.NullTime","x-order":9,"x-oapi-codegen-extra-tags":{db:"deleted_at",json:"deletedAt,omitempty"}},roleNames:{type:"array","x-go-type":"pq.StringArray","x-go-type-import":{path:"github.com/lib/pq"},description:"Names of the roles assigned to the user within this organization. Free-form, user-generated role names; not a fixed enumeration.",items:{type:"string"},"x-order":10,"x-oapi-codegen-extra-tags":{db:"role_names",json:"roleNames"}}}},TeamWithRoles:{type:"object",additionalProperties:false,description:"A team the user is a member of, together with the names of the roles assigned to that user within the team. Returned as an item of User.teams.teamsWithRoles. The role names are dynamic, user-generated values (no fixed enumeration).",required:["id","name","roleNames"],properties:{id:{description:"Unique identifier of the team.","x-go-name":"ID","x-order":1,"x-oapi-codegen-extra-tags":{db:"id",json:"id,omitempty"},type:"string",format:"uuid","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"}},name:{type:"string",description:"Name of the team.","x-order":2,"x-oapi-codegen-extra-tags":{db:"name",json:"name,omitempty"}},description:{type:"string",description:"Human readable description of the team.","x-order":3,"x-oapi-codegen-extra-tags":{db:"description",json:"description,omitempty"}},owner:{description:"Identifier of the team owner.","x-order":4,"x-oapi-codegen-extra-tags":{db:"owner",json:"owner,omitempty"},type:"string",format:"uuid","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"}},metadata:{type:"object",additionalProperties:true,description:"Free-form metadata associated with the team.","x-go-type":"core.Map","x-go-type-skip-optional-pointer":true,"x-order":5,"x-oapi-codegen-extra-tags":{db:"metadata",json:"metadata,omitempty"}},createdAt:{description:"Timestamp when the team was created.","x-order":6,"x-oapi-codegen-extra-tags":{db:"created_at",json:"createdAt,omitempty"},type:"string",format:"date-time","x-go-type-skip-optional-pointer":true},updatedAt:{description:"Timestamp when the team was last updated.","x-order":7,"x-oapi-codegen-extra-tags":{db:"updated_at",json:"updatedAt,omitempty"},type:"string",format:"date-time","x-go-type-skip-optional-pointer":true},deletedAt:{type:"string",format:"date-time",nullable:true,description:"Timestamp when the team was soft-deleted (null if not deleted).","x-go-type":"core.NullTime","x-order":8,"x-oapi-codegen-extra-tags":{db:"deleted_at",json:"deletedAt,omitempty"}},roleNames:{type:"array","x-go-type":"pq.StringArray","x-go-type-import":{path:"github.com/lib/pq"},description:"Names of the roles assigned to the user within this team. Free-form, user-generated role names; not a fixed enumeration.",items:{type:"string"},"x-order":9,"x-oapi-codegen-extra-tags":{db:"role_names",json:"roleNames"}}}},Preference:{"x-generate-db-helpers":true,type:"object",required:["anonymousUsageStats","anonymousPerfResults","updatedAt","dashboardPreferences","selectedOrganizationId","selectedWorkspaceForOrganizations","usersExtensionPreferences","remoteProviderPreferences"],properties:{meshAdapters:{type:"array",items:{"x-go-type":"Adapter",type:"object",description:"Placeholder for Adapter struct definition."},description:"The mesh adapters of the preference."},grafana:{"x-go-type":"Grafana",type:"object",properties:{grafanaUrl:{type:"string",description:"Grafana URL for the user configuration.",maxLength:500},grafanaApiKey:{type:"string",description:"Grafana API key for the user configuration.",maxLength:500},selectedBoardsConfigs:{type:"array",items:{type:"object",properties:{board:{type:"object",description:"Placeholder for GrafanaBoard definition (define fields as needed)"},panels:{type:"array",items:{type:"object",description:"Grafana panel structure imported from github.com/grafana-tools/sdk"},description:"Panels selected for the Grafana board configuration."},templateVars:{type:"array",items:{type:"string"},description:"Template variables applied to the selected Grafana board configuration."}}},description:"Selected Grafana board configurations for the user."}}},prometheus:{"x-go-type":"Prometheus",type:"object",properties:{prometheusUrl:{type:"string",description:"The prometheus URL of the prometheus.",maxLength:500},selectedPrometheusBoardsConfigs:{type:"array",items:{type:"object",properties:{board:{type:"object",description:"Placeholder for GrafanaBoard definition (define fields as needed)"},panels:{type:"array",items:{type:"object",description:"Grafana panel structure imported from github.com/grafana-tools/sdk"},description:"Panels selected for the Grafana board configuration."},templateVars:{type:"array",items:{type:"string"},description:"Template variables applied to the selected Grafana board configuration."}}},description:"The selected prometheus boards configs of the prometheus."}}},loadTestPrefs:{"x-go-type":"LoadTestPreferences",type:"object",properties:{c:{type:"integer",description:"Concurrent requests",minimum:0},qps:{type:"integer",description:"Queries per second",minimum:0},t:{type:"string",description:"Duration",maxLength:500},gen:{type:"string",description:"Load generator",maxLength:500}}},anonymousUsageStats:{type:"boolean",description:"The anonymous usage stats of the preference."},anonymousPerfResults:{type:"boolean",description:"The anonymous perf results of the preference."},updatedAt:{type:"string",format:"date-time",description:"Timestamp of when the resource was last updated."},dashboardPreferences:{type:"object",additionalProperties:true,description:"The dashboard preferences of the preference."},selectedOrganizationId:{type:"string",description:"ID of the associated selectedOrganization.",maxLength:500,format:"uuid"},selectedWorkspaceForOrganizations:{type:"object",additionalProperties:{type:"string"},description:"The selected workspace for organizations of the preference."},usersExtensionPreferences:{type:"object",additionalProperties:true,description:"The users extension preferences of the preference."},remoteProviderPreferences:{type:"object",additionalProperties:true,description:"The remote provider preferences of the preference."}}},Adapter:{type:"object",description:"Placeholder for Adapter struct definition."},Grafana:{type:"object",properties:{grafanaUrl:{type:"string",description:"Grafana URL for the user configuration.",maxLength:500},grafanaApiKey:{type:"string",description:"Grafana API key for the user configuration.",maxLength:500},selectedBoardsConfigs:{type:"array",items:{type:"object",properties:{board:{type:"object",description:"Placeholder for GrafanaBoard definition (define fields as needed)"},panels:{type:"array",items:{type:"object",description:"Grafana panel structure imported from github.com/grafana-tools/sdk"},description:"Panels selected for the Grafana board configuration."},templateVars:{type:"array",items:{type:"string"},description:"Template variables applied to the selected Grafana board configuration."}}},description:"Selected Grafana board configurations for the user."}}},SelectedGrafanaConfig:{type:"object",properties:{board:{type:"object",description:"Placeholder for GrafanaBoard definition (define fields as needed)"},panels:{type:"array",items:{type:"object",description:"Grafana panel structure imported from github.com/grafana-tools/sdk"},description:"Panels selected for the Grafana board configuration."},templateVars:{type:"array",items:{type:"string"},description:"Template variables applied to the selected Grafana board configuration."}}},GrafanaBoard:{type:"object",description:"Placeholder for GrafanaBoard definition (define fields as needed)"},Panel:{type:"object",description:"Grafana panel structure imported from github.com/grafana-tools/sdk"},Prometheus:{type:"object",properties:{prometheusUrl:{type:"string",description:"The prometheus URL of the prometheus.",maxLength:500},selectedPrometheusBoardsConfigs:{type:"array",items:{type:"object",properties:{board:{type:"object",description:"Placeholder for GrafanaBoard definition (define fields as needed)"},panels:{type:"array",items:{type:"object",description:"Grafana panel structure imported from github.com/grafana-tools/sdk"},description:"Panels selected for the Grafana board configuration."},templateVars:{type:"array",items:{type:"string"},description:"Template variables applied to the selected Grafana board configuration."}}},description:"The selected prometheus boards configs of the prometheus."}}},LoadTestPreferences:{type:"object",properties:{c:{type:"integer",description:"Concurrent requests",minimum:0},qps:{type:"integer",description:"Queries per second",minimum:0},t:{type:"string",description:"Duration",maxLength:500},gen:{type:"string",description:"Load generator",maxLength:500}}},Social:{description:"Various online profiles associated with the user account, like GitHub, LinkedIn, X, and so on.",type:"object",properties:{site:{type:"string",maxLength:50,description:"The site of the social."},link:{type:"string",format:"uri",description:"The link of the social."}},required:["site","link"]}}}},t=e;
|
|
1
|
+
var e={openapi:"3.0.3",info:{title:"User",description:"OpenAPI schema for user management in Meshery Cloud.",version:"v1beta3",contact:{name:"Meshery Maintainers",email:"maintainers@meshery.io",url:"https://meshery.io"},license:{name:"Apache 2.0",url:"https://www.apache.org/licenses/LICENSE-2.0.html"}},security:[{jwt:[]}],tags:[{name:"users",description:"Operations related to users"}],paths:{"/api/users":{get:{"x-internal":["cloud","meshery"],tags:["users"],operationId:"getUsers",summary:"Get public users",description:"Returns the publicly viewable user directory. Records are reduced to the PublicUser projection (username and avatar); personally identifying fields such as email and real names are never served on this unauthenticated path.",security:[],parameters:[{name:"page",in:"query",description:"Get responses by page",schema:{type:"integer",minimum:0}},{name:"pageSize",in:"query",description:"Number of responses to return per page. Canonical camelCase pagination parameter; prefer this over the deprecated all-lowercase `pagesize`.",schema:{type:"integer",minimum:1}},{name:"search",in:"query",description:"Get responses that match search param value",schema:{type:"string"}},{name:"order",in:"query",description:"Get ordered responses",schema:{type:"string"}},{name:"filter",in:"query",description:"Get filtered reponses",schema:{type:"string"}}],responses:{200:{description:"Paginated list of public users",content:{"application/json":{schema:{type:"object",description:"Paginated list of publicly viewable user records",required:["page","pageSize","totalCount","data"],properties:{page:{type:"integer",description:"Current page number of the result set.",minimum:0},pageSize:{type:"integer",description:"Number of items per page.",minimum:1},totalCount:{type:"integer",description:"Total number of items available.",minimum:0},data:{type:"array",items:{type:"object",additionalProperties:false,description:"Publicly viewable projection of User served by the unauthenticated public users directory. Deliberately excludes email, real names, and every other personally identifying or account-internal field.",required:["id"],properties:{id:{description:"Unique identifier for the user","x-go-name":"ID","x-oapi-codegen-extra-tags":{db:"id",json:"id"},type:"string",format:"uuid","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"}},userId:{deprecated:true,description:"Deprecated duplicate of id kept for consumers that predate the retirement of the legacy user_id column; always equals id.","x-go-name":"UserID","x-oapi-codegen-extra-tags":{db:"user_id",json:"userId,omitempty"},type:"string",format:"uuid","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"}},username:{type:"string",maxLength:200,description:"Public username of the user","x-go-type-skip-optional-pointer":true,"x-oapi-codegen-extra-tags":{db:"username",json:"username,omitempty"}},avatarUrl:{type:"string",format:"uri",maxLength:500,description:"URL to user's avatar image","x-go-type-skip-optional-pointer":true,"x-oapi-codegen-extra-tags":{db:"avatar_url",json:"avatarUrl,omitempty"}}}},description:"Public user records for the requested page."}}}}}},400:{description:"Invalid request body or request param",content:{"text/plain":{schema:{type:"string"}}}},401:{description:"Expired JWT token used or insufficient privilege",content:{"text/plain":{schema:{type:"string"}}}},500:{description:"Internal server error",content:{"text/plain":{schema:{type:"string"}}}}}}},"/api/identity/users/search":{get:{"x-internal":["cloud","meshery"],tags:["users"],operationId:"searchUsers",summary:"Search users",description:"Searches user accounts by name, username, or email and returns the SearchableUser collaboration projection. Serves authenticated people-picker flows such as sharing a design with other users. A blank search returns an empty page.",parameters:[{name:"page",in:"query",description:"Get responses by page",schema:{type:"integer",minimum:0}},{name:"pageSize",in:"query",description:"Number of responses to return per page. Canonical camelCase pagination parameter; prefer this over the deprecated all-lowercase `pagesize`.",schema:{type:"integer",minimum:1}},{name:"search",in:"query",description:"Get responses that match search param value",schema:{type:"string"}},{name:"order",in:"query",description:"Get ordered responses",schema:{type:"string"}},{name:"filter",in:"query",description:"Get filtered reponses",schema:{type:"string"}}],responses:{200:{description:"Paginated list of matching users in the searchable projection",content:{"application/json":{schema:{type:"object",description:"Paginated list of users in the searchable collaboration projection",required:["page","pageSize","totalCount","data"],properties:{page:{type:"integer",description:"Current page number of the result set.",minimum:0},pageSize:{type:"integer",description:"Number of items per page.",minimum:1},totalCount:{type:"integer",description:"Total number of items available.",minimum:0},data:{type:"array",items:{type:"object",additionalProperties:false,description:"Minimal collaboration projection of User served by the authenticated user-search endpoints (people-picker flows such as sharing a design). Carries just enough to identify and display a person - name, username, email, avatar - and deliberately excludes roles, organization and team membership, preferences, and login metadata.",required:["id"],properties:{id:{description:"Unique identifier for the user","x-go-name":"ID","x-oapi-codegen-extra-tags":{db:"id",json:"id"},type:"string",format:"uuid","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"}},userId:{deprecated:true,description:"Deprecated duplicate of id kept for consumers that predate the retirement of the legacy user_id column; always equals id.","x-go-name":"UserID","x-oapi-codegen-extra-tags":{db:"user_id",json:"userId,omitempty"},type:"string",format:"uuid","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"}},username:{type:"string",maxLength:200,description:"Public username of the user","x-go-type-skip-optional-pointer":true,"x-oapi-codegen-extra-tags":{db:"username",json:"username,omitempty"}},firstName:{type:"string",maxLength:200,description:"User's first name","x-go-type-skip-optional-pointer":true,"x-oapi-codegen-extra-tags":{db:"first_name",json:"firstName,omitempty"}},lastName:{type:"string",maxLength:300,description:"User's last name","x-go-type-skip-optional-pointer":true,"x-oapi-codegen-extra-tags":{db:"last_name",json:"lastName,omitempty"}},email:{type:"string",format:"email",maxLength:300,description:"User's email address","x-go-type-skip-optional-pointer":true,"x-oapi-codegen-extra-tags":{db:"email",json:"email,omitempty"}},avatarUrl:{type:"string",format:"uri",maxLength:500,description:"URL to user's avatar image","x-go-type-skip-optional-pointer":true,"x-oapi-codegen-extra-tags":{db:"avatar_url",json:"avatarUrl,omitempty"}},deletedAt:{description:"Timestamp when the user record was soft-deleted (null if not deleted)","x-oapi-codegen-extra-tags":{db:"deleted_at",json:"deletedAt,omitempty"},"x-go-type":"meshcore.NullTime","x-go-type-import":{name:"meshcore",path:"github.com/meshery/schemas/models/core"},type:"string",format:"date-time",nullable:true,"x-go-type-skip-optional-pointer":true}}},description:"Matching user records for the requested page."}}}}}},400:{description:"Invalid request body or request param",content:{"text/plain":{schema:{type:"string"}}}},401:{description:"Expired JWT token used or insufficient privilege",content:{"text/plain":{schema:{type:"string"}}}},500:{description:"Internal server error",content:{"text/plain":{schema:{type:"string"}}}}}}},"/api/identity/orgs/{orgId}/users/search":{get:{"x-internal":["cloud"],tags:["users"],operationId:"searchUsersInOrg",summary:"Search users within an organization scope",description:"Searches user accounts on behalf of an organization context and returns the SearchableUser collaboration projection. A blank search returns an empty page.",parameters:[{name:"orgId",in:"path",required:true,description:"Organization ID","x-go-name":"OrgID",schema:{type:"string",format:"uuid"}},{name:"page",in:"query",description:"Get responses by page",schema:{type:"integer",minimum:0}},{name:"pageSize",in:"query",description:"Number of responses to return per page. Canonical camelCase pagination parameter; prefer this over the deprecated all-lowercase `pagesize`.",schema:{type:"integer",minimum:1}},{name:"search",in:"query",description:"Get responses that match search param value",schema:{type:"string"}},{name:"order",in:"query",description:"Get ordered responses",schema:{type:"string"}},{name:"filter",in:"query",description:"Get filtered reponses",schema:{type:"string"}}],responses:{200:{description:"Paginated list of matching users in the searchable projection",content:{"application/json":{schema:{type:"object",description:"Paginated list of users in the searchable collaboration projection",required:["page","pageSize","totalCount","data"],properties:{page:{type:"integer",description:"Current page number of the result set.",minimum:0},pageSize:{type:"integer",description:"Number of items per page.",minimum:1},totalCount:{type:"integer",description:"Total number of items available.",minimum:0},data:{type:"array",items:{type:"object",additionalProperties:false,description:"Minimal collaboration projection of User served by the authenticated user-search endpoints (people-picker flows such as sharing a design). Carries just enough to identify and display a person - name, username, email, avatar - and deliberately excludes roles, organization and team membership, preferences, and login metadata.",required:["id"],properties:{id:{description:"Unique identifier for the user","x-go-name":"ID","x-oapi-codegen-extra-tags":{db:"id",json:"id"},type:"string",format:"uuid","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"}},userId:{deprecated:true,description:"Deprecated duplicate of id kept for consumers that predate the retirement of the legacy user_id column; always equals id.","x-go-name":"UserID","x-oapi-codegen-extra-tags":{db:"user_id",json:"userId,omitempty"},type:"string",format:"uuid","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"}},username:{type:"string",maxLength:200,description:"Public username of the user","x-go-type-skip-optional-pointer":true,"x-oapi-codegen-extra-tags":{db:"username",json:"username,omitempty"}},firstName:{type:"string",maxLength:200,description:"User's first name","x-go-type-skip-optional-pointer":true,"x-oapi-codegen-extra-tags":{db:"first_name",json:"firstName,omitempty"}},lastName:{type:"string",maxLength:300,description:"User's last name","x-go-type-skip-optional-pointer":true,"x-oapi-codegen-extra-tags":{db:"last_name",json:"lastName,omitempty"}},email:{type:"string",format:"email",maxLength:300,description:"User's email address","x-go-type-skip-optional-pointer":true,"x-oapi-codegen-extra-tags":{db:"email",json:"email,omitempty"}},avatarUrl:{type:"string",format:"uri",maxLength:500,description:"URL to user's avatar image","x-go-type-skip-optional-pointer":true,"x-oapi-codegen-extra-tags":{db:"avatar_url",json:"avatarUrl,omitempty"}},deletedAt:{description:"Timestamp when the user record was soft-deleted (null if not deleted)","x-oapi-codegen-extra-tags":{db:"deleted_at",json:"deletedAt,omitempty"},"x-go-type":"meshcore.NullTime","x-go-type-import":{name:"meshcore",path:"github.com/meshery/schemas/models/core"},type:"string",format:"date-time",nullable:true,"x-go-type-skip-optional-pointer":true}}},description:"Matching user records for the requested page."}}}}}},400:{description:"Invalid request body or request param",content:{"text/plain":{schema:{type:"string"}}}},401:{description:"Expired JWT token used or insufficient privilege",content:{"text/plain":{schema:{type:"string"}}}},500:{description:"Internal server error",content:{"text/plain":{schema:{type:"string"}}}}}}}},components:{securitySchemes:{jwt:{type:"http",scheme:"bearer",bearerFormat:"JWT"}},responses:{400:{description:"Invalid request body or request param",content:{"text/plain":{schema:{type:"string"}}}},401:{description:"Expired JWT token used or insufficient privilege",content:{"text/plain":{schema:{type:"string"}}}},404:{description:"Result not found",content:{"text/plain":{schema:{type:"string"}}}},500:{description:"Internal server error",content:{"text/plain":{schema:{type:"string"}}}}},parameters:{orgId:{name:"orgId",in:"path",required:true,description:"Organization ID","x-go-name":"OrgID",schema:{type:"string",format:"uuid"}},page:{name:"page",in:"query",description:"Get responses by page",schema:{type:"integer",minimum:0}},pageSize:{name:"pageSize",in:"query",description:"Number of responses to return per page. Canonical camelCase pagination parameter; prefer this over the deprecated all-lowercase `pagesize`.",schema:{type:"integer",minimum:1}},search:{name:"search",in:"query",description:"Get responses that match search param value",schema:{type:"string"}},order:{name:"order",in:"query",description:"Get ordered responses",schema:{type:"string"}},filter:{name:"filter",in:"query",description:"Get filtered reponses",schema:{type:"string"}}},schemas:{User:{type:"object",description:"Represents a user",required:["id","provider","email","firstName","lastName","status","createdAt","updatedAt","lastLoginTime","deletedAt"],properties:{id:{description:"Unique identifier for the user","x-go-name":"ID","x-oapi-codegen-extra-tags":{db:"id",json:"id"},type:"string",format:"uuid","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"}},provider:{type:"string",maxLength:100,description:"Authentication provider (e.g., Google, Github)",example:["local","github","google","twitter"],"x-oapi-codegen-extra-tags":{db:"provider",json:"provider"}},email:{type:"string",format:"email",maxLength:300,description:"User's email address","x-oapi-codegen-extra-tags":{db:"email",json:"email"}},firstName:{type:"string",maxLength:200,description:"User's first name","x-oapi-codegen-extra-tags":{db:"first_name",json:"firstName"}},lastName:{type:"string",maxLength:300,description:"User's last name","x-oapi-codegen-extra-tags":{db:"last_name",json:"lastName"}},avatarUrl:{type:"string",format:"uri",maxLength:500,description:"URL to user's avatar image","x-oapi-codegen-extra-tags":{db:"avatar_url",json:"avatarUrl"}},status:{type:"string",maxLength:100,enum:["active","inactive","pending","anonymous"],description:"User account status","x-oapi-codegen-extra-tags":{db:"status",json:"status"}},bio:{type:"string",maxLength:1e3,default:"",description:"User's biography or description","x-oapi-codegen-extra-tags":{db:"bio",json:"bio"}},country:{type:"object",description:"User's country information stored as JSONB",additionalProperties:true,"x-go-type":"core.Map","x-go-type-skip-optional-pointer":true,"x-oapi-codegen-extra-tags":{db:"country",json:"country"}},region:{type:"object",description:"User's region information stored as JSONB",additionalProperties:true,"x-go-type":"core.Map","x-go-type-skip-optional-pointer":true,"x-oapi-codegen-extra-tags":{db:"region",json:"region"}},preferences:{"x-go-type":"Preference",description:"User preferences stored as JSONB","x-oapi-codegen-extra-tags":{db:"preferences",json:"preferences"},"x-generate-db-helpers":true,type:"object",required:["anonymousUsageStats","anonymousPerfResults","updatedAt","dashboardPreferences","selectedOrganizationId","selectedWorkspaceForOrganizations","usersExtensionPreferences","remoteProviderPreferences"],properties:{meshAdapters:{type:"array",items:{"x-go-type":"Adapter",type:"object",description:"Placeholder for Adapter struct definition."},description:"The mesh adapters of the preference."},grafana:{"x-go-type":"Grafana",type:"object",properties:{grafanaUrl:{type:"string",description:"Grafana URL for the user configuration.",maxLength:500},grafanaApiKey:{type:"string",description:"Grafana API key for the user configuration.",maxLength:500},selectedBoardsConfigs:{type:"array",items:{type:"object",properties:{board:{type:"object",description:"Placeholder for GrafanaBoard definition (define fields as needed)"},panels:{type:"array",items:{type:"object",description:"Grafana panel structure imported from github.com/grafana-tools/sdk"},description:"Panels selected for the Grafana board configuration."},templateVars:{type:"array",items:{type:"string"},description:"Template variables applied to the selected Grafana board configuration."}}},description:"Selected Grafana board configurations for the user."}}},prometheus:{"x-go-type":"Prometheus",type:"object",properties:{prometheusUrl:{type:"string",description:"The prometheus URL of the prometheus.",maxLength:500},selectedPrometheusBoardsConfigs:{type:"array",items:{type:"object",properties:{board:{type:"object",description:"Placeholder for GrafanaBoard definition (define fields as needed)"},panels:{type:"array",items:{type:"object",description:"Grafana panel structure imported from github.com/grafana-tools/sdk"},description:"Panels selected for the Grafana board configuration."},templateVars:{type:"array",items:{type:"string"},description:"Template variables applied to the selected Grafana board configuration."}}},description:"The selected prometheus boards configs of the prometheus."}}},loadTestPrefs:{"x-go-type":"LoadTestPreferences",type:"object",properties:{c:{type:"integer",description:"Concurrent requests",minimum:0},qps:{type:"integer",description:"Queries per second",minimum:0},t:{type:"string",description:"Duration",maxLength:500},gen:{type:"string",description:"Load generator",maxLength:500}}},anonymousUsageStats:{type:"boolean",description:"The anonymous usage stats of the preference."},anonymousPerfResults:{type:"boolean",description:"The anonymous perf results of the preference."},updatedAt:{type:"string",format:"date-time",description:"Timestamp of when the resource was last updated."},dashboardPreferences:{type:"object",additionalProperties:true,description:"The dashboard preferences of the preference."},selectedOrganizationId:{type:"string",description:"ID of the associated selectedOrganization.",maxLength:500,format:"uuid"},selectedWorkspaceForOrganizations:{type:"object",additionalProperties:{type:"string"},description:"The selected workspace for organizations of the preference."},usersExtensionPreferences:{type:"object",additionalProperties:true,description:"The users extension preferences of the preference."},remoteProviderPreferences:{type:"object",additionalProperties:true,description:"The remote provider preferences of the preference."}}},acceptedTermsAt:{description:"Timestamp when user accepted terms and conditions","x-oapi-codegen-extra-tags":{db:"accepted_terms_at",json:"acceptedTermsAt"},type:"string",format:"date-time","x-go-type-skip-optional-pointer":true},firstLoginTime:{description:"Timestamp of user's first login","x-oapi-codegen-extra-tags":{db:"first_login_time",json:"firstLoginTime"},type:"string",format:"date-time","x-go-type-skip-optional-pointer":true},lastLoginTime:{description:"Timestamp of user's most recent login","x-oapi-codegen-extra-tags":{db:"last_login_time",json:"lastLoginTime"},type:"string",format:"date-time","x-go-type-skip-optional-pointer":true},createdAt:{description:"Timestamp when the user record was created","x-oapi-codegen-extra-tags":{db:"created_at",json:"createdAt"},type:"string",format:"date-time","x-go-type-skip-optional-pointer":true},updatedAt:{description:"Timestamp when the user record was last updated","x-oapi-codegen-extra-tags":{db:"updated_at",json:"updatedAt"},type:"string",format:"date-time","x-go-type-skip-optional-pointer":true},socials:{type:"array",description:"Various online profiles associated with the user account","x-go-type":"UserSocials",items:{"x-go-type":"Social",description:"Various online profiles associated with the user account, like GitHub, LinkedIn, X, and so on.",type:"object",properties:{site:{type:"string",maxLength:50,description:"The site of the social."},link:{type:"string",format:"uri",description:"The link of the social."}},required:["site","link"]},"x-oapi-codegen-extra-tags":{db:"socials",json:"socials"}},deletedAt:{type:"string",format:"date-time",nullable:true,description:"Timestamp when the user record was soft-deleted (null if not deleted)","x-go-type":"core.NullTime","x-oapi-codegen-extra-tags":{db:"deleted_at",json:"deletedAt"}},roleNames:{type:"array","x-go-type":"pq.StringArray","x-go-type-import":{path:"github.com/lib/pq"},"x-go-type-skip-optional-pointer":true,items:{type:"string"},description:'Names of the global roles assigned to the user. Free-form, user-generated values sourced from the roles table (role_name is a varchar, not a fixed enumeration); the seeded system roles such as "admin", "organization admin" and "user" are a subset, not the whole set.',example:["organization admin","user"],"x-oapi-codegen-extra-tags":{db:"role_names",json:"roleNames"}},teams:{type:"object",description:"Teams the user belongs to with role information","x-oapi-codegen-extra-tags":{db:"teams",json:"teams"},properties:{teamsWithRoles:{type:"array",nullable:true,description:"Team memberships for the user with their assigned roles. null means the team memberships were not measured: the read failed, so the list is unknown. An empty array is only ever a measured absence of memberships.",items:{type:"object",additionalProperties:false,description:"A team the user is a member of, together with the names of the roles assigned to that user within the team. Returned as an item of User.teams.teamsWithRoles. The role names are dynamic, user-generated values (no fixed enumeration).",required:["id","name","roleNames"],properties:{id:{description:"Unique identifier of the team.","x-go-name":"ID","x-order":1,"x-oapi-codegen-extra-tags":{db:"id",json:"id,omitempty"},type:"string",format:"uuid","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"}},name:{type:"string",description:"Name of the team.","x-order":2,"x-oapi-codegen-extra-tags":{db:"name",json:"name,omitempty"}},description:{type:"string",description:"Human readable description of the team.","x-order":3,"x-oapi-codegen-extra-tags":{db:"description",json:"description,omitempty"}},owner:{description:"Identifier of the team owner.","x-order":4,"x-oapi-codegen-extra-tags":{db:"owner",json:"owner,omitempty"},type:"string",format:"uuid","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"}},metadata:{type:"object",additionalProperties:true,description:"Free-form metadata associated with the team.","x-go-type":"core.Map","x-go-type-skip-optional-pointer":true,"x-order":5,"x-oapi-codegen-extra-tags":{db:"metadata",json:"metadata,omitempty"}},createdAt:{description:"Timestamp when the team was created.","x-order":6,"x-oapi-codegen-extra-tags":{db:"created_at",json:"createdAt,omitempty"},type:"string",format:"date-time","x-go-type-skip-optional-pointer":true},updatedAt:{description:"Timestamp when the team was last updated.","x-order":7,"x-oapi-codegen-extra-tags":{db:"updated_at",json:"updatedAt,omitempty"},type:"string",format:"date-time","x-go-type-skip-optional-pointer":true},deletedAt:{type:"string",format:"date-time",nullable:true,description:"Timestamp when the team was soft-deleted (null if not deleted).","x-go-type":"core.NullTime","x-order":8,"x-oapi-codegen-extra-tags":{db:"deleted_at",json:"deletedAt,omitempty"}},roleNames:{type:"array","x-go-type":"pq.StringArray","x-go-type-import":{path:"github.com/lib/pq"},description:"Names of the roles assigned to the user within this team. Free-form, user-generated role names; not a fixed enumeration.",items:{type:"string"},"x-order":9,"x-oapi-codegen-extra-tags":{db:"role_names",json:"roleNames"}}}},"x-oapi-codegen-extra-tags":{db:"teams_with_roles",json:"teamsWithRoles"}},totalCount:{type:"integer",nullable:true,description:"Total number of team memberships for the user. null means the count was not measured: the membership read failed, so the value is unknown and must be presented as unknown, never as 0. A number, including 0, is always a measured value.",minimum:0,"x-oapi-codegen-extra-tags":{db:"total_count",json:"totalCount"}}}},organizations:{type:"object",description:"Organizations the user belongs to with role information","x-oapi-codegen-extra-tags":{db:"organizations",json:"organizations"},properties:{organizationsWithRoles:{type:"array",nullable:true,description:"Organization memberships for the user with their assigned roles. null means the organization memberships were not measured: the read failed, so the list is unknown. An empty array is only ever a measured absence of memberships.",items:{type:"object",additionalProperties:false,description:"An organization the user is a member of, together with the names of the roles assigned to that user within the organization. Returned as an item of User.organizations.organizationsWithRoles. The role names are dynamic, user-generated values (no fixed enumeration).",required:["id","name","roleNames"],properties:{id:{description:"Unique identifier of the organization.","x-go-name":"ID","x-order":1,"x-oapi-codegen-extra-tags":{db:"id",json:"id,omitempty"},type:"string",format:"uuid","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"}},name:{type:"string",description:"Name of the organization.","x-order":2,"x-oapi-codegen-extra-tags":{db:"name",json:"name,omitempty"}},description:{type:"string",description:"Human readable description of the organization.","x-order":3,"x-oapi-codegen-extra-tags":{db:"description",json:"description,omitempty"}},country:{type:"string",description:"Country associated with the organization.","x-order":4,"x-oapi-codegen-extra-tags":{db:"country",json:"country,omitempty"}},region:{type:"string",description:"Region associated with the organization.","x-order":5,"x-oapi-codegen-extra-tags":{db:"region",json:"region,omitempty"}},owner:{description:"Identifier of the organization owner.","x-order":6,"x-oapi-codegen-extra-tags":{db:"owner",json:"owner,omitempty"},type:"string",format:"uuid","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"}},createdAt:{description:"Timestamp when the organization was created.","x-order":7,"x-oapi-codegen-extra-tags":{db:"created_at",json:"createdAt,omitempty"},type:"string",format:"date-time","x-go-type-skip-optional-pointer":true},updatedAt:{description:"Timestamp when the organization was last updated.","x-order":8,"x-oapi-codegen-extra-tags":{db:"updated_at",json:"updatedAt,omitempty"},type:"string",format:"date-time","x-go-type-skip-optional-pointer":true},deletedAt:{type:"string",format:"date-time",nullable:true,description:"Timestamp when the organization was soft-deleted (null if not deleted).","x-go-type":"core.NullTime","x-order":9,"x-oapi-codegen-extra-tags":{db:"deleted_at",json:"deletedAt,omitempty"}},roleNames:{type:"array","x-go-type":"pq.StringArray","x-go-type-import":{path:"github.com/lib/pq"},description:"Names of the roles assigned to the user within this organization. Free-form, user-generated role names; not a fixed enumeration.",items:{type:"string"},"x-order":10,"x-oapi-codegen-extra-tags":{db:"role_names",json:"roleNames"}}}},"x-oapi-codegen-extra-tags":{db:"organizations_with_roles",json:"organizationsWithRoles"}},totalCount:{type:"integer",nullable:true,description:"Total number of organization memberships for the user. null means the count was not measured: the membership read failed, so the value is unknown and must be presented as unknown, never as 0. A number, including 0, is always a measured value.",minimum:0,"x-oapi-codegen-extra-tags":{db:"total_count",json:"totalCount"}}}}},additionalProperties:false},PublicUser:{type:"object",additionalProperties:false,description:"Publicly viewable projection of User served by the unauthenticated public users directory. Deliberately excludes email, real names, and every other personally identifying or account-internal field.",required:["id"],properties:{id:{description:"Unique identifier for the user","x-go-name":"ID","x-oapi-codegen-extra-tags":{db:"id",json:"id"},type:"string",format:"uuid","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"}},userId:{deprecated:true,description:"Deprecated duplicate of id kept for consumers that predate the retirement of the legacy user_id column; always equals id.","x-go-name":"UserID","x-oapi-codegen-extra-tags":{db:"user_id",json:"userId,omitempty"},type:"string",format:"uuid","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"}},username:{type:"string",maxLength:200,description:"Public username of the user","x-go-type-skip-optional-pointer":true,"x-oapi-codegen-extra-tags":{db:"username",json:"username,omitempty"}},avatarUrl:{type:"string",format:"uri",maxLength:500,description:"URL to user's avatar image","x-go-type-skip-optional-pointer":true,"x-oapi-codegen-extra-tags":{db:"avatar_url",json:"avatarUrl,omitempty"}}}},PublicUsersPage:{type:"object",description:"Paginated list of publicly viewable user records",required:["page","pageSize","totalCount","data"],properties:{page:{type:"integer",description:"Current page number of the result set.",minimum:0},pageSize:{type:"integer",description:"Number of items per page.",minimum:1},totalCount:{type:"integer",description:"Total number of items available.",minimum:0},data:{type:"array",items:{type:"object",additionalProperties:false,description:"Publicly viewable projection of User served by the unauthenticated public users directory. Deliberately excludes email, real names, and every other personally identifying or account-internal field.",required:["id"],properties:{id:{description:"Unique identifier for the user","x-go-name":"ID","x-oapi-codegen-extra-tags":{db:"id",json:"id"},type:"string",format:"uuid","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"}},userId:{deprecated:true,description:"Deprecated duplicate of id kept for consumers that predate the retirement of the legacy user_id column; always equals id.","x-go-name":"UserID","x-oapi-codegen-extra-tags":{db:"user_id",json:"userId,omitempty"},type:"string",format:"uuid","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"}},username:{type:"string",maxLength:200,description:"Public username of the user","x-go-type-skip-optional-pointer":true,"x-oapi-codegen-extra-tags":{db:"username",json:"username,omitempty"}},avatarUrl:{type:"string",format:"uri",maxLength:500,description:"URL to user's avatar image","x-go-type-skip-optional-pointer":true,"x-oapi-codegen-extra-tags":{db:"avatar_url",json:"avatarUrl,omitempty"}}}},description:"Public user records for the requested page."}}},SearchableUser:{type:"object",additionalProperties:false,description:"Minimal collaboration projection of User served by the authenticated user-search endpoints (people-picker flows such as sharing a design). Carries just enough to identify and display a person - name, username, email, avatar - and deliberately excludes roles, organization and team membership, preferences, and login metadata.",required:["id"],properties:{id:{description:"Unique identifier for the user","x-go-name":"ID","x-oapi-codegen-extra-tags":{db:"id",json:"id"},type:"string",format:"uuid","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"}},userId:{deprecated:true,description:"Deprecated duplicate of id kept for consumers that predate the retirement of the legacy user_id column; always equals id.","x-go-name":"UserID","x-oapi-codegen-extra-tags":{db:"user_id",json:"userId,omitempty"},type:"string",format:"uuid","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"}},username:{type:"string",maxLength:200,description:"Public username of the user","x-go-type-skip-optional-pointer":true,"x-oapi-codegen-extra-tags":{db:"username",json:"username,omitempty"}},firstName:{type:"string",maxLength:200,description:"User's first name","x-go-type-skip-optional-pointer":true,"x-oapi-codegen-extra-tags":{db:"first_name",json:"firstName,omitempty"}},lastName:{type:"string",maxLength:300,description:"User's last name","x-go-type-skip-optional-pointer":true,"x-oapi-codegen-extra-tags":{db:"last_name",json:"lastName,omitempty"}},email:{type:"string",format:"email",maxLength:300,description:"User's email address","x-go-type-skip-optional-pointer":true,"x-oapi-codegen-extra-tags":{db:"email",json:"email,omitempty"}},avatarUrl:{type:"string",format:"uri",maxLength:500,description:"URL to user's avatar image","x-go-type-skip-optional-pointer":true,"x-oapi-codegen-extra-tags":{db:"avatar_url",json:"avatarUrl,omitempty"}},deletedAt:{description:"Timestamp when the user record was soft-deleted (null if not deleted)","x-oapi-codegen-extra-tags":{db:"deleted_at",json:"deletedAt,omitempty"},"x-go-type":"meshcore.NullTime","x-go-type-import":{name:"meshcore",path:"github.com/meshery/schemas/models/core"},type:"string",format:"date-time",nullable:true,"x-go-type-skip-optional-pointer":true}}},SearchableUsersPage:{type:"object",description:"Paginated list of users in the searchable collaboration projection",required:["page","pageSize","totalCount","data"],properties:{page:{type:"integer",description:"Current page number of the result set.",minimum:0},pageSize:{type:"integer",description:"Number of items per page.",minimum:1},totalCount:{type:"integer",description:"Total number of items available.",minimum:0},data:{type:"array",items:{type:"object",additionalProperties:false,description:"Minimal collaboration projection of User served by the authenticated user-search endpoints (people-picker flows such as sharing a design). Carries just enough to identify and display a person - name, username, email, avatar - and deliberately excludes roles, organization and team membership, preferences, and login metadata.",required:["id"],properties:{id:{description:"Unique identifier for the user","x-go-name":"ID","x-oapi-codegen-extra-tags":{db:"id",json:"id"},type:"string",format:"uuid","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"}},userId:{deprecated:true,description:"Deprecated duplicate of id kept for consumers that predate the retirement of the legacy user_id column; always equals id.","x-go-name":"UserID","x-oapi-codegen-extra-tags":{db:"user_id",json:"userId,omitempty"},type:"string",format:"uuid","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"}},username:{type:"string",maxLength:200,description:"Public username of the user","x-go-type-skip-optional-pointer":true,"x-oapi-codegen-extra-tags":{db:"username",json:"username,omitempty"}},firstName:{type:"string",maxLength:200,description:"User's first name","x-go-type-skip-optional-pointer":true,"x-oapi-codegen-extra-tags":{db:"first_name",json:"firstName,omitempty"}},lastName:{type:"string",maxLength:300,description:"User's last name","x-go-type-skip-optional-pointer":true,"x-oapi-codegen-extra-tags":{db:"last_name",json:"lastName,omitempty"}},email:{type:"string",format:"email",maxLength:300,description:"User's email address","x-go-type-skip-optional-pointer":true,"x-oapi-codegen-extra-tags":{db:"email",json:"email,omitempty"}},avatarUrl:{type:"string",format:"uri",maxLength:500,description:"URL to user's avatar image","x-go-type-skip-optional-pointer":true,"x-oapi-codegen-extra-tags":{db:"avatar_url",json:"avatarUrl,omitempty"}},deletedAt:{description:"Timestamp when the user record was soft-deleted (null if not deleted)","x-oapi-codegen-extra-tags":{db:"deleted_at",json:"deletedAt,omitempty"},"x-go-type":"meshcore.NullTime","x-go-type-import":{name:"meshcore",path:"github.com/meshery/schemas/models/core"},type:"string",format:"date-time",nullable:true,"x-go-type-skip-optional-pointer":true}}},description:"Matching user records for the requested page."}}},UserEmailAddress:{type:"object",additionalProperties:false,description:"One email address associated with a user account. A user has exactly one primary address (mirrored in users.email) and any number of secondary addresses accumulated from account consolidation or explicit addition. Uniqueness across live addresses is enforced case-insensitively.",required:["id","userId","email","verified","isPrimary","source","createdAt","updatedAt"],properties:{id:{description:"Unique identifier for this email-address record","x-go-name":"ID","x-oapi-codegen-extra-tags":{db:"id",json:"id"},type:"string",format:"uuid","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"}},userId:{description:"The user (users.id) this address belongs to","x-go-name":"UserID","x-oapi-codegen-extra-tags":{db:"owner",json:"userId"},type:"string",format:"uuid","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"}},email:{type:"string",format:"email",maxLength:300,description:"The email address","x-oapi-codegen-extra-tags":{db:"email",json:"email"}},verified:{type:"boolean",default:false,description:"Whether the address was verified (per Kratos verifiable addresses) at record time","x-oapi-codegen-extra-tags":{db:"verified",json:"verified"}},isPrimary:{type:"boolean",default:false,description:"Exactly one live primary address per user; mirrors users.email","x-oapi-codegen-extra-tags":{db:"is_primary",json:"isPrimary"}},source:{type:"string",enum:["signup","consolidation","backfill","manual"],description:"How this address became associated with the account","x-oapi-codegen-extra-tags":{db:"source",json:"source"}},createdAt:{"x-oapi-codegen-extra-tags":{db:"created_at",json:"createdAt"},type:"string",format:"date-time","x-go-type-skip-optional-pointer":true},updatedAt:{"x-oapi-codegen-extra-tags":{db:"updated_at",json:"updatedAt"},type:"string",format:"date-time","x-go-type-skip-optional-pointer":true},deletedAt:{"x-oapi-codegen-extra-tags":{db:"deleted_at",json:"deletedAt"},description:"SQL null Timestamp to handle null values of time.","x-go-type":"meshcore.NullTime","x-go-type-import":{name:"meshcore",path:"github.com/meshery/schemas/models/core"},type:"string",format:"date-time",nullable:true,"x-go-type-skip-optional-pointer":true}}},OrganizationWithRoles:{type:"object",additionalProperties:false,description:"An organization the user is a member of, together with the names of the roles assigned to that user within the organization. Returned as an item of User.organizations.organizationsWithRoles. The role names are dynamic, user-generated values (no fixed enumeration).",required:["id","name","roleNames"],properties:{id:{description:"Unique identifier of the organization.","x-go-name":"ID","x-order":1,"x-oapi-codegen-extra-tags":{db:"id",json:"id,omitempty"},type:"string",format:"uuid","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"}},name:{type:"string",description:"Name of the organization.","x-order":2,"x-oapi-codegen-extra-tags":{db:"name",json:"name,omitempty"}},description:{type:"string",description:"Human readable description of the organization.","x-order":3,"x-oapi-codegen-extra-tags":{db:"description",json:"description,omitempty"}},country:{type:"string",description:"Country associated with the organization.","x-order":4,"x-oapi-codegen-extra-tags":{db:"country",json:"country,omitempty"}},region:{type:"string",description:"Region associated with the organization.","x-order":5,"x-oapi-codegen-extra-tags":{db:"region",json:"region,omitempty"}},owner:{description:"Identifier of the organization owner.","x-order":6,"x-oapi-codegen-extra-tags":{db:"owner",json:"owner,omitempty"},type:"string",format:"uuid","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"}},createdAt:{description:"Timestamp when the organization was created.","x-order":7,"x-oapi-codegen-extra-tags":{db:"created_at",json:"createdAt,omitempty"},type:"string",format:"date-time","x-go-type-skip-optional-pointer":true},updatedAt:{description:"Timestamp when the organization was last updated.","x-order":8,"x-oapi-codegen-extra-tags":{db:"updated_at",json:"updatedAt,omitempty"},type:"string",format:"date-time","x-go-type-skip-optional-pointer":true},deletedAt:{type:"string",format:"date-time",nullable:true,description:"Timestamp when the organization was soft-deleted (null if not deleted).","x-go-type":"core.NullTime","x-order":9,"x-oapi-codegen-extra-tags":{db:"deleted_at",json:"deletedAt,omitempty"}},roleNames:{type:"array","x-go-type":"pq.StringArray","x-go-type-import":{path:"github.com/lib/pq"},description:"Names of the roles assigned to the user within this organization. Free-form, user-generated role names; not a fixed enumeration.",items:{type:"string"},"x-order":10,"x-oapi-codegen-extra-tags":{db:"role_names",json:"roleNames"}}}},TeamWithRoles:{type:"object",additionalProperties:false,description:"A team the user is a member of, together with the names of the roles assigned to that user within the team. Returned as an item of User.teams.teamsWithRoles. The role names are dynamic, user-generated values (no fixed enumeration).",required:["id","name","roleNames"],properties:{id:{description:"Unique identifier of the team.","x-go-name":"ID","x-order":1,"x-oapi-codegen-extra-tags":{db:"id",json:"id,omitempty"},type:"string",format:"uuid","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"}},name:{type:"string",description:"Name of the team.","x-order":2,"x-oapi-codegen-extra-tags":{db:"name",json:"name,omitempty"}},description:{type:"string",description:"Human readable description of the team.","x-order":3,"x-oapi-codegen-extra-tags":{db:"description",json:"description,omitempty"}},owner:{description:"Identifier of the team owner.","x-order":4,"x-oapi-codegen-extra-tags":{db:"owner",json:"owner,omitempty"},type:"string",format:"uuid","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"}},metadata:{type:"object",additionalProperties:true,description:"Free-form metadata associated with the team.","x-go-type":"core.Map","x-go-type-skip-optional-pointer":true,"x-order":5,"x-oapi-codegen-extra-tags":{db:"metadata",json:"metadata,omitempty"}},createdAt:{description:"Timestamp when the team was created.","x-order":6,"x-oapi-codegen-extra-tags":{db:"created_at",json:"createdAt,omitempty"},type:"string",format:"date-time","x-go-type-skip-optional-pointer":true},updatedAt:{description:"Timestamp when the team was last updated.","x-order":7,"x-oapi-codegen-extra-tags":{db:"updated_at",json:"updatedAt,omitempty"},type:"string",format:"date-time","x-go-type-skip-optional-pointer":true},deletedAt:{type:"string",format:"date-time",nullable:true,description:"Timestamp when the team was soft-deleted (null if not deleted).","x-go-type":"core.NullTime","x-order":8,"x-oapi-codegen-extra-tags":{db:"deleted_at",json:"deletedAt,omitempty"}},roleNames:{type:"array","x-go-type":"pq.StringArray","x-go-type-import":{path:"github.com/lib/pq"},description:"Names of the roles assigned to the user within this team. Free-form, user-generated role names; not a fixed enumeration.",items:{type:"string"},"x-order":9,"x-oapi-codegen-extra-tags":{db:"role_names",json:"roleNames"}}}},Preference:{"x-generate-db-helpers":true,type:"object",required:["anonymousUsageStats","anonymousPerfResults","updatedAt","dashboardPreferences","selectedOrganizationId","selectedWorkspaceForOrganizations","usersExtensionPreferences","remoteProviderPreferences"],properties:{meshAdapters:{type:"array",items:{"x-go-type":"Adapter",type:"object",description:"Placeholder for Adapter struct definition."},description:"The mesh adapters of the preference."},grafana:{"x-go-type":"Grafana",type:"object",properties:{grafanaUrl:{type:"string",description:"Grafana URL for the user configuration.",maxLength:500},grafanaApiKey:{type:"string",description:"Grafana API key for the user configuration.",maxLength:500},selectedBoardsConfigs:{type:"array",items:{type:"object",properties:{board:{type:"object",description:"Placeholder for GrafanaBoard definition (define fields as needed)"},panels:{type:"array",items:{type:"object",description:"Grafana panel structure imported from github.com/grafana-tools/sdk"},description:"Panels selected for the Grafana board configuration."},templateVars:{type:"array",items:{type:"string"},description:"Template variables applied to the selected Grafana board configuration."}}},description:"Selected Grafana board configurations for the user."}}},prometheus:{"x-go-type":"Prometheus",type:"object",properties:{prometheusUrl:{type:"string",description:"The prometheus URL of the prometheus.",maxLength:500},selectedPrometheusBoardsConfigs:{type:"array",items:{type:"object",properties:{board:{type:"object",description:"Placeholder for GrafanaBoard definition (define fields as needed)"},panels:{type:"array",items:{type:"object",description:"Grafana panel structure imported from github.com/grafana-tools/sdk"},description:"Panels selected for the Grafana board configuration."},templateVars:{type:"array",items:{type:"string"},description:"Template variables applied to the selected Grafana board configuration."}}},description:"The selected prometheus boards configs of the prometheus."}}},loadTestPrefs:{"x-go-type":"LoadTestPreferences",type:"object",properties:{c:{type:"integer",description:"Concurrent requests",minimum:0},qps:{type:"integer",description:"Queries per second",minimum:0},t:{type:"string",description:"Duration",maxLength:500},gen:{type:"string",description:"Load generator",maxLength:500}}},anonymousUsageStats:{type:"boolean",description:"The anonymous usage stats of the preference."},anonymousPerfResults:{type:"boolean",description:"The anonymous perf results of the preference."},updatedAt:{type:"string",format:"date-time",description:"Timestamp of when the resource was last updated."},dashboardPreferences:{type:"object",additionalProperties:true,description:"The dashboard preferences of the preference."},selectedOrganizationId:{type:"string",description:"ID of the associated selectedOrganization.",maxLength:500,format:"uuid"},selectedWorkspaceForOrganizations:{type:"object",additionalProperties:{type:"string"},description:"The selected workspace for organizations of the preference."},usersExtensionPreferences:{type:"object",additionalProperties:true,description:"The users extension preferences of the preference."},remoteProviderPreferences:{type:"object",additionalProperties:true,description:"The remote provider preferences of the preference."}}},Adapter:{type:"object",description:"Placeholder for Adapter struct definition."},Grafana:{type:"object",properties:{grafanaUrl:{type:"string",description:"Grafana URL for the user configuration.",maxLength:500},grafanaApiKey:{type:"string",description:"Grafana API key for the user configuration.",maxLength:500},selectedBoardsConfigs:{type:"array",items:{type:"object",properties:{board:{type:"object",description:"Placeholder for GrafanaBoard definition (define fields as needed)"},panels:{type:"array",items:{type:"object",description:"Grafana panel structure imported from github.com/grafana-tools/sdk"},description:"Panels selected for the Grafana board configuration."},templateVars:{type:"array",items:{type:"string"},description:"Template variables applied to the selected Grafana board configuration."}}},description:"Selected Grafana board configurations for the user."}}},SelectedGrafanaConfig:{type:"object",properties:{board:{type:"object",description:"Placeholder for GrafanaBoard definition (define fields as needed)"},panels:{type:"array",items:{type:"object",description:"Grafana panel structure imported from github.com/grafana-tools/sdk"},description:"Panels selected for the Grafana board configuration."},templateVars:{type:"array",items:{type:"string"},description:"Template variables applied to the selected Grafana board configuration."}}},GrafanaBoard:{type:"object",description:"Placeholder for GrafanaBoard definition (define fields as needed)"},Panel:{type:"object",description:"Grafana panel structure imported from github.com/grafana-tools/sdk"},Prometheus:{type:"object",properties:{prometheusUrl:{type:"string",description:"The prometheus URL of the prometheus.",maxLength:500},selectedPrometheusBoardsConfigs:{type:"array",items:{type:"object",properties:{board:{type:"object",description:"Placeholder for GrafanaBoard definition (define fields as needed)"},panels:{type:"array",items:{type:"object",description:"Grafana panel structure imported from github.com/grafana-tools/sdk"},description:"Panels selected for the Grafana board configuration."},templateVars:{type:"array",items:{type:"string"},description:"Template variables applied to the selected Grafana board configuration."}}},description:"The selected prometheus boards configs of the prometheus."}}},LoadTestPreferences:{type:"object",properties:{c:{type:"integer",description:"Concurrent requests",minimum:0},qps:{type:"integer",description:"Queries per second",minimum:0},t:{type:"string",description:"Duration",maxLength:500},gen:{type:"string",description:"Load generator",maxLength:500}}},Social:{description:"Various online profiles associated with the user account, like GitHub, LinkedIn, X, and so on.",type:"object",properties:{site:{type:"string",maxLength:50,description:"The site of the social."},link:{type:"string",format:"uri",description:"The link of the social."}},required:["site","link"]}}}},t=e;
|
|
2
2
|
export{t as default};
|
package/dist/index.d.mts
CHANGED
|
@@ -35955,7 +35955,7 @@ interface components$1 {
|
|
|
35955
35955
|
roleNames?: string[];
|
|
35956
35956
|
/** @description Teams the user belongs to with role information */
|
|
35957
35957
|
teams?: {
|
|
35958
|
-
/** @description Team memberships for the user with their assigned roles. */
|
|
35958
|
+
/** @description Team memberships for the user with their assigned roles. null means the team memberships were not measured: the read failed, so the list is unknown. An empty array is only ever a measured absence of memberships. */
|
|
35959
35959
|
teamsWithRoles?: {
|
|
35960
35960
|
/**
|
|
35961
35961
|
* Format: uuid
|
|
@@ -35992,13 +35992,13 @@ interface components$1 {
|
|
|
35992
35992
|
deletedAt?: string | null;
|
|
35993
35993
|
/** @description Names of the roles assigned to the user within this team. Free-form, user-generated role names; not a fixed enumeration. */
|
|
35994
35994
|
roleNames: string[];
|
|
35995
|
-
}[];
|
|
35996
|
-
/** @description Total number of team memberships
|
|
35997
|
-
totalCount?: number;
|
|
35995
|
+
}[] | null;
|
|
35996
|
+
/** @description Total number of team memberships for the user. null means the count was not measured: the membership read failed, so the value is unknown and must be presented as unknown, never as 0. A number, including 0, is always a measured value. */
|
|
35997
|
+
totalCount?: number | null;
|
|
35998
35998
|
};
|
|
35999
35999
|
/** @description Organizations the user belongs to with role information */
|
|
36000
36000
|
organizations?: {
|
|
36001
|
-
/** @description Organization memberships for the user with their assigned roles. */
|
|
36001
|
+
/** @description Organization memberships for the user with their assigned roles. null means the organization memberships were not measured: the read failed, so the list is unknown. An empty array is only ever a measured absence of memberships. */
|
|
36002
36002
|
organizationsWithRoles?: {
|
|
36003
36003
|
/**
|
|
36004
36004
|
* Format: uuid
|
|
@@ -36035,9 +36035,9 @@ interface components$1 {
|
|
|
36035
36035
|
deletedAt?: string | null;
|
|
36036
36036
|
/** @description Names of the roles assigned to the user within this organization. Free-form, user-generated role names; not a fixed enumeration. */
|
|
36037
36037
|
roleNames: string[];
|
|
36038
|
-
}[];
|
|
36039
|
-
/** @description Total number of organization memberships
|
|
36040
|
-
totalCount?: number;
|
|
36038
|
+
}[] | null;
|
|
36039
|
+
/** @description Total number of organization memberships for the user. null means the count was not measured: the membership read failed, so the value is unknown and must be presented as unknown, never as 0. A number, including 0, is always a measured value. */
|
|
36040
|
+
totalCount?: number | null;
|
|
36041
36041
|
};
|
|
36042
36042
|
};
|
|
36043
36043
|
/** @description Publicly viewable projection of User served by the unauthenticated public users directory. Deliberately excludes email, real names, and every other personally identifying or account-internal field. */
|
package/dist/index.d.ts
CHANGED
|
@@ -35955,7 +35955,7 @@ interface components$1 {
|
|
|
35955
35955
|
roleNames?: string[];
|
|
35956
35956
|
/** @description Teams the user belongs to with role information */
|
|
35957
35957
|
teams?: {
|
|
35958
|
-
/** @description Team memberships for the user with their assigned roles. */
|
|
35958
|
+
/** @description Team memberships for the user with their assigned roles. null means the team memberships were not measured: the read failed, so the list is unknown. An empty array is only ever a measured absence of memberships. */
|
|
35959
35959
|
teamsWithRoles?: {
|
|
35960
35960
|
/**
|
|
35961
35961
|
* Format: uuid
|
|
@@ -35992,13 +35992,13 @@ interface components$1 {
|
|
|
35992
35992
|
deletedAt?: string | null;
|
|
35993
35993
|
/** @description Names of the roles assigned to the user within this team. Free-form, user-generated role names; not a fixed enumeration. */
|
|
35994
35994
|
roleNames: string[];
|
|
35995
|
-
}[];
|
|
35996
|
-
/** @description Total number of team memberships
|
|
35997
|
-
totalCount?: number;
|
|
35995
|
+
}[] | null;
|
|
35996
|
+
/** @description Total number of team memberships for the user. null means the count was not measured: the membership read failed, so the value is unknown and must be presented as unknown, never as 0. A number, including 0, is always a measured value. */
|
|
35997
|
+
totalCount?: number | null;
|
|
35998
35998
|
};
|
|
35999
35999
|
/** @description Organizations the user belongs to with role information */
|
|
36000
36000
|
organizations?: {
|
|
36001
|
-
/** @description Organization memberships for the user with their assigned roles. */
|
|
36001
|
+
/** @description Organization memberships for the user with their assigned roles. null means the organization memberships were not measured: the read failed, so the list is unknown. An empty array is only ever a measured absence of memberships. */
|
|
36002
36002
|
organizationsWithRoles?: {
|
|
36003
36003
|
/**
|
|
36004
36004
|
* Format: uuid
|
|
@@ -36035,9 +36035,9 @@ interface components$1 {
|
|
|
36035
36035
|
deletedAt?: string | null;
|
|
36036
36036
|
/** @description Names of the roles assigned to the user within this organization. Free-form, user-generated role names; not a fixed enumeration. */
|
|
36037
36037
|
roleNames: string[];
|
|
36038
|
-
}[];
|
|
36039
|
-
/** @description Total number of organization memberships
|
|
36040
|
-
totalCount?: number;
|
|
36038
|
+
}[] | null;
|
|
36039
|
+
/** @description Total number of organization memberships for the user. null means the count was not measured: the membership read failed, so the value is unknown and must be presented as unknown, never as 0. A number, including 0, is always a measured value. */
|
|
36040
|
+
totalCount?: number | null;
|
|
36041
36041
|
};
|
|
36042
36042
|
};
|
|
36043
36043
|
/** @description Publicly viewable projection of User served by the unauthenticated public users directory. Deliberately excludes email, real names, and every other personally identifying or account-internal field. */
|
package/dist/mesheryApi.d.mts
CHANGED
|
@@ -9616,7 +9616,7 @@ type GetUsersForOrgApiResponse = {
|
|
|
9616
9616
|
roleNames?: string[];
|
|
9617
9617
|
/** Teams the user belongs to with role information */
|
|
9618
9618
|
teams?: {
|
|
9619
|
-
/** Team memberships for the user with their assigned roles. */
|
|
9619
|
+
/** Team memberships for the user with their assigned roles. null means the team memberships were not measured: the read failed, so the list is unknown. An empty array is only ever a measured absence of memberships. */
|
|
9620
9620
|
teamsWithRoles?: {
|
|
9621
9621
|
/** Unique identifier of the team. */
|
|
9622
9622
|
id: string;
|
|
@@ -9638,13 +9638,13 @@ type GetUsersForOrgApiResponse = {
|
|
|
9638
9638
|
deletedAt?: string | null;
|
|
9639
9639
|
/** Names of the roles assigned to the user within this team. Free-form, user-generated role names; not a fixed enumeration. */
|
|
9640
9640
|
roleNames: string[];
|
|
9641
|
-
}[];
|
|
9642
|
-
/** Total number of team memberships
|
|
9643
|
-
totalCount?: number;
|
|
9641
|
+
}[] | null;
|
|
9642
|
+
/** Total number of team memberships for the user. null means the count was not measured: the membership read failed, so the value is unknown and must be presented as unknown, never as 0. A number, including 0, is always a measured value. */
|
|
9643
|
+
totalCount?: number | null;
|
|
9644
9644
|
};
|
|
9645
9645
|
/** Organizations the user belongs to with role information */
|
|
9646
9646
|
organizations?: {
|
|
9647
|
-
/** Organization memberships for the user with their assigned roles. */
|
|
9647
|
+
/** Organization memberships for the user with their assigned roles. null means the organization memberships were not measured: the read failed, so the list is unknown. An empty array is only ever a measured absence of memberships. */
|
|
9648
9648
|
organizationsWithRoles?: {
|
|
9649
9649
|
/** Unique identifier of the organization. */
|
|
9650
9650
|
id: string;
|
|
@@ -9666,9 +9666,9 @@ type GetUsersForOrgApiResponse = {
|
|
|
9666
9666
|
deletedAt?: string | null;
|
|
9667
9667
|
/** Names of the roles assigned to the user within this organization. Free-form, user-generated role names; not a fixed enumeration. */
|
|
9668
9668
|
roleNames: string[];
|
|
9669
|
-
}[];
|
|
9670
|
-
/** Total number of organization memberships
|
|
9671
|
-
totalCount?: number;
|
|
9669
|
+
}[] | null;
|
|
9670
|
+
/** Total number of organization memberships for the user. null means the count was not measured: the membership read failed, so the value is unknown and must be presented as unknown, never as 0. A number, including 0, is always a measured value. */
|
|
9671
|
+
totalCount?: number | null;
|
|
9672
9672
|
};
|
|
9673
9673
|
}[];
|
|
9674
9674
|
};
|
|
@@ -9805,7 +9805,7 @@ type GetUserProfileByIdApiResponse = {
|
|
|
9805
9805
|
roleNames?: string[];
|
|
9806
9806
|
/** Teams the user belongs to with role information */
|
|
9807
9807
|
teams?: {
|
|
9808
|
-
/** Team memberships for the user with their assigned roles. */
|
|
9808
|
+
/** Team memberships for the user with their assigned roles. null means the team memberships were not measured: the read failed, so the list is unknown. An empty array is only ever a measured absence of memberships. */
|
|
9809
9809
|
teamsWithRoles?: {
|
|
9810
9810
|
/** Unique identifier of the team. */
|
|
9811
9811
|
id: string;
|
|
@@ -9827,13 +9827,13 @@ type GetUserProfileByIdApiResponse = {
|
|
|
9827
9827
|
deletedAt?: string | null;
|
|
9828
9828
|
/** Names of the roles assigned to the user within this team. Free-form, user-generated role names; not a fixed enumeration. */
|
|
9829
9829
|
roleNames: string[];
|
|
9830
|
-
}[];
|
|
9831
|
-
/** Total number of team memberships
|
|
9832
|
-
totalCount?: number;
|
|
9830
|
+
}[] | null;
|
|
9831
|
+
/** Total number of team memberships for the user. null means the count was not measured: the membership read failed, so the value is unknown and must be presented as unknown, never as 0. A number, including 0, is always a measured value. */
|
|
9832
|
+
totalCount?: number | null;
|
|
9833
9833
|
};
|
|
9834
9834
|
/** Organizations the user belongs to with role information */
|
|
9835
9835
|
organizations?: {
|
|
9836
|
-
/** Organization memberships for the user with their assigned roles. */
|
|
9836
|
+
/** Organization memberships for the user with their assigned roles. null means the organization memberships were not measured: the read failed, so the list is unknown. An empty array is only ever a measured absence of memberships. */
|
|
9837
9837
|
organizationsWithRoles?: {
|
|
9838
9838
|
/** Unique identifier of the organization. */
|
|
9839
9839
|
id: string;
|
|
@@ -9855,9 +9855,9 @@ type GetUserProfileByIdApiResponse = {
|
|
|
9855
9855
|
deletedAt?: string | null;
|
|
9856
9856
|
/** Names of the roles assigned to the user within this organization. Free-form, user-generated role names; not a fixed enumeration. */
|
|
9857
9857
|
roleNames: string[];
|
|
9858
|
-
}[];
|
|
9859
|
-
/** Total number of organization memberships
|
|
9860
|
-
totalCount?: number;
|
|
9858
|
+
}[] | null;
|
|
9859
|
+
/** Total number of organization memberships for the user. null means the count was not measured: the membership read failed, so the value is unknown and must be presented as unknown, never as 0. A number, including 0, is always a measured value. */
|
|
9860
|
+
totalCount?: number | null;
|
|
9861
9861
|
};
|
|
9862
9862
|
};
|
|
9863
9863
|
type GetUserProfileByIdApiArg = {
|
|
@@ -9981,7 +9981,7 @@ type GetUserApiResponse = {
|
|
|
9981
9981
|
roleNames?: string[];
|
|
9982
9982
|
/** Teams the user belongs to with role information */
|
|
9983
9983
|
teams?: {
|
|
9984
|
-
/** Team memberships for the user with their assigned roles. */
|
|
9984
|
+
/** Team memberships for the user with their assigned roles. null means the team memberships were not measured: the read failed, so the list is unknown. An empty array is only ever a measured absence of memberships. */
|
|
9985
9985
|
teamsWithRoles?: {
|
|
9986
9986
|
/** Unique identifier of the team. */
|
|
9987
9987
|
id: string;
|
|
@@ -10003,13 +10003,13 @@ type GetUserApiResponse = {
|
|
|
10003
10003
|
deletedAt?: string | null;
|
|
10004
10004
|
/** Names of the roles assigned to the user within this team. Free-form, user-generated role names; not a fixed enumeration. */
|
|
10005
10005
|
roleNames: string[];
|
|
10006
|
-
}[];
|
|
10007
|
-
/** Total number of team memberships
|
|
10008
|
-
totalCount?: number;
|
|
10006
|
+
}[] | null;
|
|
10007
|
+
/** Total number of team memberships for the user. null means the count was not measured: the membership read failed, so the value is unknown and must be presented as unknown, never as 0. A number, including 0, is always a measured value. */
|
|
10008
|
+
totalCount?: number | null;
|
|
10009
10009
|
};
|
|
10010
10010
|
/** Organizations the user belongs to with role information */
|
|
10011
10011
|
organizations?: {
|
|
10012
|
-
/** Organization memberships for the user with their assigned roles. */
|
|
10012
|
+
/** Organization memberships for the user with their assigned roles. null means the organization memberships were not measured: the read failed, so the list is unknown. An empty array is only ever a measured absence of memberships. */
|
|
10013
10013
|
organizationsWithRoles?: {
|
|
10014
10014
|
/** Unique identifier of the organization. */
|
|
10015
10015
|
id: string;
|
|
@@ -10031,9 +10031,9 @@ type GetUserApiResponse = {
|
|
|
10031
10031
|
deletedAt?: string | null;
|
|
10032
10032
|
/** Names of the roles assigned to the user within this organization. Free-form, user-generated role names; not a fixed enumeration. */
|
|
10033
10033
|
roleNames: string[];
|
|
10034
|
-
}[];
|
|
10035
|
-
/** Total number of organization memberships
|
|
10036
|
-
totalCount?: number;
|
|
10034
|
+
}[] | null;
|
|
10035
|
+
/** Total number of organization memberships for the user. null means the count was not measured: the membership read failed, so the value is unknown and must be presented as unknown, never as 0. A number, including 0, is always a measured value. */
|
|
10036
|
+
totalCount?: number | null;
|
|
10037
10037
|
};
|
|
10038
10038
|
};
|
|
10039
10039
|
type GetUserApiArg = void;
|
|
@@ -12274,7 +12274,7 @@ type ImportDesignApiResponse =
|
|
|
12274
12274
|
roleNames?: string[];
|
|
12275
12275
|
/** Teams the user belongs to with role information */
|
|
12276
12276
|
teams?: {
|
|
12277
|
-
/** Team memberships for the user with their assigned roles. */
|
|
12277
|
+
/** Team memberships for the user with their assigned roles. null means the team memberships were not measured: the read failed, so the list is unknown. An empty array is only ever a measured absence of memberships. */
|
|
12278
12278
|
teamsWithRoles?: {
|
|
12279
12279
|
/** Unique identifier of the team. */
|
|
12280
12280
|
id: string;
|
|
@@ -12296,13 +12296,13 @@ type ImportDesignApiResponse =
|
|
|
12296
12296
|
deletedAt?: string | null;
|
|
12297
12297
|
/** Names of the roles assigned to the user within this team. Free-form, user-generated role names; not a fixed enumeration. */
|
|
12298
12298
|
roleNames: string[];
|
|
12299
|
-
}[];
|
|
12300
|
-
/** Total number of team memberships
|
|
12301
|
-
totalCount?: number;
|
|
12299
|
+
}[] | null;
|
|
12300
|
+
/** Total number of team memberships for the user. null means the count was not measured: the membership read failed, so the value is unknown and must be presented as unknown, never as 0. A number, including 0, is always a measured value. */
|
|
12301
|
+
totalCount?: number | null;
|
|
12302
12302
|
};
|
|
12303
12303
|
/** Organizations the user belongs to with role information */
|
|
12304
12304
|
organizations?: {
|
|
12305
|
-
/** Organization memberships for the user with their assigned roles. */
|
|
12305
|
+
/** Organization memberships for the user with their assigned roles. null means the organization memberships were not measured: the read failed, so the list is unknown. An empty array is only ever a measured absence of memberships. */
|
|
12306
12306
|
organizationsWithRoles?: {
|
|
12307
12307
|
/** Unique identifier of the organization. */
|
|
12308
12308
|
id: string;
|
|
@@ -12324,9 +12324,9 @@ type ImportDesignApiResponse =
|
|
|
12324
12324
|
deletedAt?: string | null;
|
|
12325
12325
|
/** Names of the roles assigned to the user within this organization. Free-form, user-generated role names; not a fixed enumeration. */
|
|
12326
12326
|
roleNames: string[];
|
|
12327
|
-
}[];
|
|
12328
|
-
/** Total number of organization memberships
|
|
12329
|
-
totalCount?: number;
|
|
12327
|
+
}[] | null;
|
|
12328
|
+
/** Total number of organization memberships for the user. null means the count was not measured: the membership read failed, so the value is unknown and must be presented as unknown, never as 0. A number, including 0, is always a measured value. */
|
|
12329
|
+
totalCount?: number | null;
|
|
12330
12330
|
};
|
|
12331
12331
|
} | null;
|
|
12332
12332
|
/** Optional structured location metadata (branch, host, path, ...). */
|