@meshery/schemas 1.1.1 → 1.2.0

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.
Files changed (35) hide show
  1. package/dist/cloudApi.d.mts +1565 -1436
  2. package/dist/cloudApi.d.ts +1565 -1436
  3. package/dist/cloudApi.js +1 -1
  4. package/dist/cloudApi.mjs +1 -1
  5. package/dist/constructs/v1beta1/credential/CredentialSchema.js +1 -1
  6. package/dist/constructs/v1beta1/credential/CredentialSchema.mjs +1 -1
  7. package/dist/constructs/v1beta1/role/RoleSchema.js +1 -1
  8. package/dist/constructs/v1beta1/role/RoleSchema.mjs +1 -1
  9. package/dist/constructs/v1beta1/schedule/ScheduleSchema.js +1 -1
  10. package/dist/constructs/v1beta1/schedule/ScheduleSchema.mjs +1 -1
  11. package/dist/constructs/v1beta1/token/TokenSchema.js +1 -1
  12. package/dist/constructs/v1beta1/token/TokenSchema.mjs +1 -1
  13. package/dist/constructs/v1beta2/credential/CredentialSchema.js +1 -1
  14. package/dist/constructs/v1beta2/credential/CredentialSchema.mjs +1 -1
  15. package/dist/constructs/v1beta2/role/RoleSchema.js +1 -1
  16. package/dist/constructs/v1beta2/role/RoleSchema.mjs +1 -1
  17. package/dist/constructs/v1beta2/schedule/Schedule.d.mts +50 -0
  18. package/dist/constructs/v1beta2/schedule/Schedule.d.ts +50 -0
  19. package/dist/constructs/v1beta2/schedule/ScheduleSchema.js +16 -6
  20. package/dist/constructs/v1beta2/schedule/ScheduleSchema.mjs +16 -6
  21. package/dist/constructs/v1beta2/team/Team.d.mts +23 -5
  22. package/dist/constructs/v1beta2/team/Team.d.ts +23 -5
  23. package/dist/constructs/v1beta2/team/TeamSchema.js +1 -1
  24. package/dist/constructs/v1beta2/team/TeamSchema.mjs +1 -1
  25. package/dist/constructs/v1beta2/token/TokenSchema.js +1 -1
  26. package/dist/constructs/v1beta2/token/TokenSchema.mjs +1 -1
  27. package/dist/constructs/v1beta3/design/Design.d.mts +360 -0
  28. package/dist/constructs/v1beta3/design/Design.d.ts +360 -0
  29. package/dist/constructs/v1beta3/design/DesignSchema.js +70 -10
  30. package/dist/constructs/v1beta3/design/DesignSchema.mjs +70 -10
  31. package/dist/constructs/v1beta3/token/TokenSchema.js +1 -1
  32. package/dist/constructs/v1beta3/token/TokenSchema.mjs +1 -1
  33. package/dist/mesheryApi.d.mts +549 -546
  34. package/dist/mesheryApi.d.ts +549 -546
  35. package/package.json +1 -1
package/dist/constructs/v1beta1/token/TokenSchema.js CHANGED
@@ -1,2 +1,2 @@
1
- 'use strict';var e={openapi:"3.0.0",info:{title:"token",description:"Documentation for Meshery Cloud REST APIs for user tokens and sessions","x-deprecated":true,"x-superseded-by":"v1beta2",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"},version:"v1beta1"},servers:[{url:"https://cloud.layer5.io",description:"Meshery Cloud production server URL"},{url:"https://staging-cloud.layer5.io",description:"Meshery Cloud staging server URL"},{url:"http://localhost:9876",description:"Meshery Cloud development server URL"}],security:[{jwt:[]}],tags:[{name:"tokens",description:"Operations related to user tokens and sessions"}],paths:{"/api/identity/tokens":{get:{"x-internal":["cloud"],tags:["tokens"],summary:"Get tokens",operationId:"getUserTokens",description:"Retrieves tokens associated with the authenticated user.",parameters:[{name:"isOAuth",in:"query",description:"Whether to retrieve OAuth-backed sessions instead of API tokens.",schema:{type:"boolean"}},{name:"page",in:"query",description:"Get responses by page",schema:{type:"string"}},{name:"pagesize",in:"query",description:"Get responses by pagesize",schema:{type:"string"}},{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"}}],responses:{200:{description:"Tokens response",content:{"application/json":{schema:{type:"object",description:"A paginated list of tokens.",required:["tokens","total_count","page","page_size"],properties:{tokens:{type:"array",items:{"x-go-type":"UserToken",type:"object",description:"Represents a user-owned API token or OAuth session.",properties:{id:{description:"Unique identifier for the token.","x-order":1,"x-oapi-codegen-extra-tags":{db:"id"},type:"string",format:"uuid","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"}},user_id:{description:"UUID of the user who owns the token.","x-order":2,"x-oapi-codegen-extra-tags":{db:"user_id"},type:"string",format:"uuid","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"}},provider:{type:"string",description:"Authentication provider associated with the token.","x-order":3,"x-oapi-codegen-extra-tags":{db:"provider"}},access_token:{type:"string",description:"Access token value.","x-order":4,"x-oapi-codegen-extra-tags":{db:"access_token"}},refresh_token:{type:"string",description:"Refresh token value when applicable.","x-order":5,"x-oapi-codegen-extra-tags":{db:"refresh_token"}},name:{type:"string",description:"Human-readable token name.","x-order":6,"x-oapi-codegen-extra-tags":{db:"name"}},purpose:{type:"string",description:"Purpose for which the token was created.","x-order":7,"x-oapi-codegen-extra-tags":{db:"purpose"}},is_oauth:{type:"boolean",description:"Whether this entry represents an OAuth session.","x-order":8,"x-oapi-codegen-extra-tags":{db:"is_oauth"}},created_at:{"x-order":9,description:"Timestamp when the resource was created.","x-go-type":"time.Time",type:"string",format:"date-time","x-go-name":"CreatedAt","x-oapi-codegen-extra-tags":{db:"created_at",yaml:"created_at"},"x-go-type-skip-optional-pointer":true},updated_at:{"x-order":10,description:"Timestamp when the resource was updated.","x-go-type":"time.Time",type:"string",format:"date-time","x-go-name":"UpdatedAt","x-oapi-codegen-extra-tags":{db:"updated_at",yaml:"updated_at"},"x-go-type-skip-optional-pointer":true}}},"x-order":1},total_count:{type:"integer",description:"Total number of tokens across all pages.","x-order":2},page:{type:"integer",description:"Current page number (zero-based).","x-order":3},page_size:{type:"integer",description:"Number of tokens per page.","x-order":4}}}}}},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"}}}}}},post:{"x-internal":["cloud"],tags:["tokens"],summary:"Generate token",operationId:"generateToken",description:"Generates a token for the authenticated user.",parameters:[{name:"name",in:"query",description:"Name of the token.",required:true,schema:{type:"string"}},{name:"purpose",in:"query",description:"Purpose for which the token is generated.",schema:{type:"string"}}],responses:{200:{description:"Token generated",content:{"application/json":{schema:{type:"object",description:"A paginated list of tokens.",required:["tokens","total_count","page","page_size"],properties:{tokens:{type:"array",items:{"x-go-type":"UserToken",type:"object",description:"Represents a user-owned API token or OAuth session.",properties:{id:{description:"Unique identifier for the token.","x-order":1,"x-oapi-codegen-extra-tags":{db:"id"},type:"string",format:"uuid","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"}},user_id:{description:"UUID of the user who owns the token.","x-order":2,"x-oapi-codegen-extra-tags":{db:"user_id"},type:"string",format:"uuid","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"}},provider:{type:"string",description:"Authentication provider associated with the token.","x-order":3,"x-oapi-codegen-extra-tags":{db:"provider"}},access_token:{type:"string",description:"Access token value.","x-order":4,"x-oapi-codegen-extra-tags":{db:"access_token"}},refresh_token:{type:"string",description:"Refresh token value when applicable.","x-order":5,"x-oapi-codegen-extra-tags":{db:"refresh_token"}},name:{type:"string",description:"Human-readable token name.","x-order":6,"x-oapi-codegen-extra-tags":{db:"name"}},purpose:{type:"string",description:"Purpose for which the token was created.","x-order":7,"x-oapi-codegen-extra-tags":{db:"purpose"}},is_oauth:{type:"boolean",description:"Whether this entry represents an OAuth session.","x-order":8,"x-oapi-codegen-extra-tags":{db:"is_oauth"}},created_at:{"x-order":9,description:"Timestamp when the resource was created.","x-go-type":"time.Time",type:"string",format:"date-time","x-go-name":"CreatedAt","x-oapi-codegen-extra-tags":{db:"created_at",yaml:"created_at"},"x-go-type-skip-optional-pointer":true},updated_at:{"x-order":10,description:"Timestamp when the resource was updated.","x-go-type":"time.Time",type:"string",format:"date-time","x-go-name":"UpdatedAt","x-oapi-codegen-extra-tags":{db:"updated_at",yaml:"updated_at"},"x-go-type-skip-optional-pointer":true}}},"x-order":1},total_count:{type:"integer",description:"Total number of tokens across all pages.","x-order":2},page:{type:"integer",description:"Current page number (zero-based).","x-order":3},page_size:{type:"integer",description:"Number of tokens per page.","x-order":4}}}}}},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"}}}}}},delete:{"x-internal":["cloud"],tags:["tokens"],summary:"Delete token",operationId:"deleteUserToken",description:"Deletes a specific token for the authenticated user.",parameters:[{name:"token_id",in:"query",description:"ID of the token.",required:true,schema:{type:"string",format:"uuid",description:"A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"}}}],responses:{200:{description:"Token deleted",content:{"application/json":{schema:{type:"object",description:"A paginated list of tokens.",required:["tokens","total_count","page","page_size"],properties:{tokens:{type:"array",items:{"x-go-type":"UserToken",type:"object",description:"Represents a user-owned API token or OAuth session.",properties:{id:{description:"Unique identifier for the token.","x-order":1,"x-oapi-codegen-extra-tags":{db:"id"},type:"string",format:"uuid","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"}},user_id:{description:"UUID of the user who owns the token.","x-order":2,"x-oapi-codegen-extra-tags":{db:"user_id"},type:"string",format:"uuid","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"}},provider:{type:"string",description:"Authentication provider associated with the token.","x-order":3,"x-oapi-codegen-extra-tags":{db:"provider"}},access_token:{type:"string",description:"Access token value.","x-order":4,"x-oapi-codegen-extra-tags":{db:"access_token"}},refresh_token:{type:"string",description:"Refresh token value when applicable.","x-order":5,"x-oapi-codegen-extra-tags":{db:"refresh_token"}},name:{type:"string",description:"Human-readable token name.","x-order":6,"x-oapi-codegen-extra-tags":{db:"name"}},purpose:{type:"string",description:"Purpose for which the token was created.","x-order":7,"x-oapi-codegen-extra-tags":{db:"purpose"}},is_oauth:{type:"boolean",description:"Whether this entry represents an OAuth session.","x-order":8,"x-oapi-codegen-extra-tags":{db:"is_oauth"}},created_at:{"x-order":9,description:"Timestamp when the resource was created.","x-go-type":"time.Time",type:"string",format:"date-time","x-go-name":"CreatedAt","x-oapi-codegen-extra-tags":{db:"created_at",yaml:"created_at"},"x-go-type-skip-optional-pointer":true},updated_at:{"x-order":10,description:"Timestamp when the resource was updated.","x-go-type":"time.Time",type:"string",format:"date-time","x-go-name":"UpdatedAt","x-oapi-codegen-extra-tags":{db:"updated_at",yaml:"updated_at"},"x-go-type-skip-optional-pointer":true}}},"x-order":1},total_count:{type:"integer",description:"Total number of tokens across all pages.","x-order":2},page:{type:"integer",description:"Current page number (zero-based).","x-order":3},page_size:{type:"integer",description:"Number of tokens per page.","x-order":4}}}}}},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/tokens/{id}":{get:{"x-internal":["cloud"],tags:["tokens"],summary:"Get token by ID",operationId:"getUserTokensById",description:"Retrieves a specific token by its ID.",parameters:[{name:"id",in:"path",description:"Token ID",required:true,schema:{type:"string",format:"uuid",description:"A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"}}}],responses:{200:{description:"Token response",content:{"application/json":{schema:{type:"object",description:"Represents a user-owned API token or OAuth session.",properties:{id:{description:"Unique identifier for the token.","x-order":1,"x-oapi-codegen-extra-tags":{db:"id"},type:"string",format:"uuid","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"}},user_id:{description:"UUID of the user who owns the token.","x-order":2,"x-oapi-codegen-extra-tags":{db:"user_id"},type:"string",format:"uuid","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"}},provider:{type:"string",description:"Authentication provider associated with the token.","x-order":3,"x-oapi-codegen-extra-tags":{db:"provider"}},access_token:{type:"string",description:"Access token value.","x-order":4,"x-oapi-codegen-extra-tags":{db:"access_token"}},refresh_token:{type:"string",description:"Refresh token value when applicable.","x-order":5,"x-oapi-codegen-extra-tags":{db:"refresh_token"}},name:{type:"string",description:"Human-readable token name.","x-order":6,"x-oapi-codegen-extra-tags":{db:"name"}},purpose:{type:"string",description:"Purpose for which the token was created.","x-order":7,"x-oapi-codegen-extra-tags":{db:"purpose"}},is_oauth:{type:"boolean",description:"Whether this entry represents an OAuth session.","x-order":8,"x-oapi-codegen-extra-tags":{db:"is_oauth"}},created_at:{"x-order":9,description:"Timestamp when the resource was created.","x-go-type":"time.Time",type:"string",format:"date-time","x-go-name":"CreatedAt","x-oapi-codegen-extra-tags":{db:"created_at",yaml:"created_at"},"x-go-type-skip-optional-pointer":true},updated_at:{"x-order":10,description:"Timestamp when the resource was updated.","x-go-type":"time.Time",type:"string",format:"date-time","x-go-name":"UpdatedAt","x-oapi-codegen-extra-tags":{db:"updated_at",yaml:"updated_at"},"x-go-type-skip-optional-pointer":true}}}}}},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"}}}}}}},"/api/identity/tokens/infinite":{get:{"x-internal":["cloud"],tags:["tokens"],summary:"Issue indefinite lifetime token",operationId:"issueIndefiniteLifetimeToken",description:"Creates a non-expiring user token for provider admin use cases.",parameters:[{name:"user_id",in:"query",description:"UUID of the user.",required:true,schema:{type:"string",format:"uuid",description:"A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"}}},{name:"provider",in:"query",description:"Remote provider.",required:true,schema:{type:"string"}}],responses:{200:{description:"Token generated",content:{"application/json":{schema:{type:"object",description:"A paginated list of tokens.",required:["tokens","total_count","page","page_size"],properties:{tokens:{type:"array",items:{"x-go-type":"UserToken",type:"object",description:"Represents a user-owned API token or OAuth session.",properties:{id:{description:"Unique identifier for the token.","x-order":1,"x-oapi-codegen-extra-tags":{db:"id"},type:"string",format:"uuid","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"}},user_id:{description:"UUID of the user who owns the token.","x-order":2,"x-oapi-codegen-extra-tags":{db:"user_id"},type:"string",format:"uuid","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"}},provider:{type:"string",description:"Authentication provider associated with the token.","x-order":3,"x-oapi-codegen-extra-tags":{db:"provider"}},access_token:{type:"string",description:"Access token value.","x-order":4,"x-oapi-codegen-extra-tags":{db:"access_token"}},refresh_token:{type:"string",description:"Refresh token value when applicable.","x-order":5,"x-oapi-codegen-extra-tags":{db:"refresh_token"}},name:{type:"string",description:"Human-readable token name.","x-order":6,"x-oapi-codegen-extra-tags":{db:"name"}},purpose:{type:"string",description:"Purpose for which the token was created.","x-order":7,"x-oapi-codegen-extra-tags":{db:"purpose"}},is_oauth:{type:"boolean",description:"Whether this entry represents an OAuth session.","x-order":8,"x-oapi-codegen-extra-tags":{db:"is_oauth"}},created_at:{"x-order":9,description:"Timestamp when the resource was created.","x-go-type":"time.Time",type:"string",format:"date-time","x-go-name":"CreatedAt","x-oapi-codegen-extra-tags":{db:"created_at",yaml:"created_at"},"x-go-type-skip-optional-pointer":true},updated_at:{"x-order":10,description:"Timestamp when the resource was updated.","x-go-type":"time.Time",type:"string",format:"date-time","x-go-name":"UpdatedAt","x-oapi-codegen-extra-tags":{db:"updated_at",yaml:"updated_at"},"x-go-type-skip-optional-pointer":true}}},"x-order":1},total_count:{type:"integer",description:"Total number of tokens across all pages.","x-order":2},page:{type:"integer",description:"Current page number (zero-based).","x-order":3},page_size:{type:"integer",description:"Number of tokens per page.","x-order":4}}}}}},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:{id:{name:"id",in:"path",description:"Token ID",required:true,schema:{type:"string",format:"uuid",description:"A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"}}},page:{name:"page",in:"query",description:"Get responses by page",schema:{type:"string"}},pagesize:{name:"pagesize",in:"query",description:"Get responses by pagesize",schema:{type:"string"}},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"}},isOAuth:{name:"isOAuth",in:"query",description:"Whether to retrieve OAuth-backed sessions instead of API tokens.",schema:{type:"boolean"}},name:{name:"name",in:"query",description:"Name of the token.",required:true,schema:{type:"string"}},purpose:{name:"purpose",in:"query",description:"Purpose for which the token is generated.",schema:{type:"string"}},tokenId:{name:"token_id",in:"query",description:"ID of the token.",required:true,schema:{type:"string",format:"uuid",description:"A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"}}},userId:{name:"user_id",in:"query",description:"UUID of the user.",required:true,schema:{type:"string",format:"uuid",description:"A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"}}},provider:{name:"provider",in:"query",description:"Remote provider.",required:true,schema:{type:"string"}}},schemas:{UserToken:{type:"object",description:"Represents a user-owned API token or OAuth session.",properties:{id:{description:"Unique identifier for the token.","x-order":1,"x-oapi-codegen-extra-tags":{db:"id"},type:"string",format:"uuid","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"}},user_id:{description:"UUID of the user who owns the token.","x-order":2,"x-oapi-codegen-extra-tags":{db:"user_id"},type:"string",format:"uuid","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"}},provider:{type:"string",description:"Authentication provider associated with the token.","x-order":3,"x-oapi-codegen-extra-tags":{db:"provider"}},access_token:{type:"string",description:"Access token value.","x-order":4,"x-oapi-codegen-extra-tags":{db:"access_token"}},refresh_token:{type:"string",description:"Refresh token value when applicable.","x-order":5,"x-oapi-codegen-extra-tags":{db:"refresh_token"}},name:{type:"string",description:"Human-readable token name.","x-order":6,"x-oapi-codegen-extra-tags":{db:"name"}},purpose:{type:"string",description:"Purpose for which the token was created.","x-order":7,"x-oapi-codegen-extra-tags":{db:"purpose"}},is_oauth:{type:"boolean",description:"Whether this entry represents an OAuth session.","x-order":8,"x-oapi-codegen-extra-tags":{db:"is_oauth"}},created_at:{"x-order":9,description:"Timestamp when the resource was created.","x-go-type":"time.Time",type:"string",format:"date-time","x-go-name":"CreatedAt","x-oapi-codegen-extra-tags":{db:"created_at",yaml:"created_at"},"x-go-type-skip-optional-pointer":true},updated_at:{"x-order":10,description:"Timestamp when the resource was updated.","x-go-type":"time.Time",type:"string",format:"date-time","x-go-name":"UpdatedAt","x-oapi-codegen-extra-tags":{db:"updated_at",yaml:"updated_at"},"x-go-type-skip-optional-pointer":true}}},TokenPage:{type:"object",description:"A paginated list of tokens.",required:["tokens","total_count","page","page_size"],properties:{tokens:{type:"array",items:{"x-go-type":"UserToken",type:"object",description:"Represents a user-owned API token or OAuth session.",properties:{id:{description:"Unique identifier for the token.","x-order":1,"x-oapi-codegen-extra-tags":{db:"id"},type:"string",format:"uuid","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"}},user_id:{description:"UUID of the user who owns the token.","x-order":2,"x-oapi-codegen-extra-tags":{db:"user_id"},type:"string",format:"uuid","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"}},provider:{type:"string",description:"Authentication provider associated with the token.","x-order":3,"x-oapi-codegen-extra-tags":{db:"provider"}},access_token:{type:"string",description:"Access token value.","x-order":4,"x-oapi-codegen-extra-tags":{db:"access_token"}},refresh_token:{type:"string",description:"Refresh token value when applicable.","x-order":5,"x-oapi-codegen-extra-tags":{db:"refresh_token"}},name:{type:"string",description:"Human-readable token name.","x-order":6,"x-oapi-codegen-extra-tags":{db:"name"}},purpose:{type:"string",description:"Purpose for which the token was created.","x-order":7,"x-oapi-codegen-extra-tags":{db:"purpose"}},is_oauth:{type:"boolean",description:"Whether this entry represents an OAuth session.","x-order":8,"x-oapi-codegen-extra-tags":{db:"is_oauth"}},created_at:{"x-order":9,description:"Timestamp when the resource was created.","x-go-type":"time.Time",type:"string",format:"date-time","x-go-name":"CreatedAt","x-oapi-codegen-extra-tags":{db:"created_at",yaml:"created_at"},"x-go-type-skip-optional-pointer":true},updated_at:{"x-order":10,description:"Timestamp when the resource was updated.","x-go-type":"time.Time",type:"string",format:"date-time","x-go-name":"UpdatedAt","x-oapi-codegen-extra-tags":{db:"updated_at",yaml:"updated_at"},"x-go-type-skip-optional-pointer":true}}},"x-order":1},total_count:{type:"integer",description:"Total number of tokens across all pages.","x-order":2},page:{type:"integer",description:"Current page number (zero-based).","x-order":3},page_size:{type:"integer",description:"Number of tokens per page.","x-order":4}}}}}},t=e;
1
+ 'use strict';var e={openapi:"3.0.0",info:{title:"token",description:"Documentation for Meshery Cloud REST APIs for user tokens and sessions","x-deprecated":true,"x-superseded-by":"v1beta2",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"},version:"v1beta1"},servers:[{url:"https://cloud.meshery.io",description:"Meshery Cloud production server URL"},{url:"https://staging-cloud.meshery.io",description:"Meshery Cloud staging server URL"},{url:"http://localhost:9876",description:"Meshery Cloud development server URL"}],security:[{jwt:[]}],tags:[{name:"tokens",description:"Operations related to user tokens and sessions"}],paths:{"/api/identity/tokens":{get:{"x-internal":["cloud"],tags:["tokens"],summary:"Get tokens",operationId:"getUserTokens",description:"Retrieves tokens associated with the authenticated user.",parameters:[{name:"isOAuth",in:"query",description:"Whether to retrieve OAuth-backed sessions instead of API tokens.",schema:{type:"boolean"}},{name:"page",in:"query",description:"Get responses by page",schema:{type:"string"}},{name:"pagesize",in:"query",description:"Get responses by pagesize",schema:{type:"string"}},{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"}}],responses:{200:{description:"Tokens response",content:{"application/json":{schema:{type:"object",description:"A paginated list of tokens.",required:["tokens","total_count","page","page_size"],properties:{tokens:{type:"array",items:{"x-go-type":"UserToken",type:"object",description:"Represents a user-owned API token or OAuth session.",properties:{id:{description:"Unique identifier for the token.","x-order":1,"x-oapi-codegen-extra-tags":{db:"id"},type:"string",format:"uuid","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"}},user_id:{description:"UUID of the user who owns the token.","x-order":2,"x-oapi-codegen-extra-tags":{db:"user_id"},type:"string",format:"uuid","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"}},provider:{type:"string",description:"Authentication provider associated with the token.","x-order":3,"x-oapi-codegen-extra-tags":{db:"provider"}},access_token:{type:"string",description:"Access token value.","x-order":4,"x-oapi-codegen-extra-tags":{db:"access_token"}},refresh_token:{type:"string",description:"Refresh token value when applicable.","x-order":5,"x-oapi-codegen-extra-tags":{db:"refresh_token"}},name:{type:"string",description:"Human-readable token name.","x-order":6,"x-oapi-codegen-extra-tags":{db:"name"}},purpose:{type:"string",description:"Purpose for which the token was created.","x-order":7,"x-oapi-codegen-extra-tags":{db:"purpose"}},is_oauth:{type:"boolean",description:"Whether this entry represents an OAuth session.","x-order":8,"x-oapi-codegen-extra-tags":{db:"is_oauth"}},created_at:{"x-order":9,description:"Timestamp when the resource was created.","x-go-type":"time.Time",type:"string",format:"date-time","x-go-name":"CreatedAt","x-oapi-codegen-extra-tags":{db:"created_at",yaml:"created_at"},"x-go-type-skip-optional-pointer":true},updated_at:{"x-order":10,description:"Timestamp when the resource was updated.","x-go-type":"time.Time",type:"string",format:"date-time","x-go-name":"UpdatedAt","x-oapi-codegen-extra-tags":{db:"updated_at",yaml:"updated_at"},"x-go-type-skip-optional-pointer":true}}},"x-order":1},total_count:{type:"integer",description:"Total number of tokens across all pages.","x-order":2},page:{type:"integer",description:"Current page number (zero-based).","x-order":3},page_size:{type:"integer",description:"Number of tokens per page.","x-order":4}}}}}},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"}}}}}},post:{"x-internal":["cloud"],tags:["tokens"],summary:"Generate token",operationId:"generateToken",description:"Generates a token for the authenticated user.",parameters:[{name:"name",in:"query",description:"Name of the token.",required:true,schema:{type:"string"}},{name:"purpose",in:"query",description:"Purpose for which the token is generated.",schema:{type:"string"}}],responses:{200:{description:"Token generated",content:{"application/json":{schema:{type:"object",description:"A paginated list of tokens.",required:["tokens","total_count","page","page_size"],properties:{tokens:{type:"array",items:{"x-go-type":"UserToken",type:"object",description:"Represents a user-owned API token or OAuth session.",properties:{id:{description:"Unique identifier for the token.","x-order":1,"x-oapi-codegen-extra-tags":{db:"id"},type:"string",format:"uuid","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"}},user_id:{description:"UUID of the user who owns the token.","x-order":2,"x-oapi-codegen-extra-tags":{db:"user_id"},type:"string",format:"uuid","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"}},provider:{type:"string",description:"Authentication provider associated with the token.","x-order":3,"x-oapi-codegen-extra-tags":{db:"provider"}},access_token:{type:"string",description:"Access token value.","x-order":4,"x-oapi-codegen-extra-tags":{db:"access_token"}},refresh_token:{type:"string",description:"Refresh token value when applicable.","x-order":5,"x-oapi-codegen-extra-tags":{db:"refresh_token"}},name:{type:"string",description:"Human-readable token name.","x-order":6,"x-oapi-codegen-extra-tags":{db:"name"}},purpose:{type:"string",description:"Purpose for which the token was created.","x-order":7,"x-oapi-codegen-extra-tags":{db:"purpose"}},is_oauth:{type:"boolean",description:"Whether this entry represents an OAuth session.","x-order":8,"x-oapi-codegen-extra-tags":{db:"is_oauth"}},created_at:{"x-order":9,description:"Timestamp when the resource was created.","x-go-type":"time.Time",type:"string",format:"date-time","x-go-name":"CreatedAt","x-oapi-codegen-extra-tags":{db:"created_at",yaml:"created_at"},"x-go-type-skip-optional-pointer":true},updated_at:{"x-order":10,description:"Timestamp when the resource was updated.","x-go-type":"time.Time",type:"string",format:"date-time","x-go-name":"UpdatedAt","x-oapi-codegen-extra-tags":{db:"updated_at",yaml:"updated_at"},"x-go-type-skip-optional-pointer":true}}},"x-order":1},total_count:{type:"integer",description:"Total number of tokens across all pages.","x-order":2},page:{type:"integer",description:"Current page number (zero-based).","x-order":3},page_size:{type:"integer",description:"Number of tokens per page.","x-order":4}}}}}},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"}}}}}},delete:{"x-internal":["cloud"],tags:["tokens"],summary:"Delete token",operationId:"deleteUserToken",description:"Deletes a specific token for the authenticated user.",parameters:[{name:"token_id",in:"query",description:"ID of the token.",required:true,schema:{type:"string",format:"uuid",description:"A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"}}}],responses:{200:{description:"Token deleted",content:{"application/json":{schema:{type:"object",description:"A paginated list of tokens.",required:["tokens","total_count","page","page_size"],properties:{tokens:{type:"array",items:{"x-go-type":"UserToken",type:"object",description:"Represents a user-owned API token or OAuth session.",properties:{id:{description:"Unique identifier for the token.","x-order":1,"x-oapi-codegen-extra-tags":{db:"id"},type:"string",format:"uuid","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"}},user_id:{description:"UUID of the user who owns the token.","x-order":2,"x-oapi-codegen-extra-tags":{db:"user_id"},type:"string",format:"uuid","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"}},provider:{type:"string",description:"Authentication provider associated with the token.","x-order":3,"x-oapi-codegen-extra-tags":{db:"provider"}},access_token:{type:"string",description:"Access token value.","x-order":4,"x-oapi-codegen-extra-tags":{db:"access_token"}},refresh_token:{type:"string",description:"Refresh token value when applicable.","x-order":5,"x-oapi-codegen-extra-tags":{db:"refresh_token"}},name:{type:"string",description:"Human-readable token name.","x-order":6,"x-oapi-codegen-extra-tags":{db:"name"}},purpose:{type:"string",description:"Purpose for which the token was created.","x-order":7,"x-oapi-codegen-extra-tags":{db:"purpose"}},is_oauth:{type:"boolean",description:"Whether this entry represents an OAuth session.","x-order":8,"x-oapi-codegen-extra-tags":{db:"is_oauth"}},created_at:{"x-order":9,description:"Timestamp when the resource was created.","x-go-type":"time.Time",type:"string",format:"date-time","x-go-name":"CreatedAt","x-oapi-codegen-extra-tags":{db:"created_at",yaml:"created_at"},"x-go-type-skip-optional-pointer":true},updated_at:{"x-order":10,description:"Timestamp when the resource was updated.","x-go-type":"time.Time",type:"string",format:"date-time","x-go-name":"UpdatedAt","x-oapi-codegen-extra-tags":{db:"updated_at",yaml:"updated_at"},"x-go-type-skip-optional-pointer":true}}},"x-order":1},total_count:{type:"integer",description:"Total number of tokens across all pages.","x-order":2},page:{type:"integer",description:"Current page number (zero-based).","x-order":3},page_size:{type:"integer",description:"Number of tokens per page.","x-order":4}}}}}},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/tokens/{id}":{get:{"x-internal":["cloud"],tags:["tokens"],summary:"Get token by ID",operationId:"getUserTokensById",description:"Retrieves a specific token by its ID.",parameters:[{name:"id",in:"path",description:"Token ID",required:true,schema:{type:"string",format:"uuid",description:"A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"}}}],responses:{200:{description:"Token response",content:{"application/json":{schema:{type:"object",description:"Represents a user-owned API token or OAuth session.",properties:{id:{description:"Unique identifier for the token.","x-order":1,"x-oapi-codegen-extra-tags":{db:"id"},type:"string",format:"uuid","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"}},user_id:{description:"UUID of the user who owns the token.","x-order":2,"x-oapi-codegen-extra-tags":{db:"user_id"},type:"string",format:"uuid","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"}},provider:{type:"string",description:"Authentication provider associated with the token.","x-order":3,"x-oapi-codegen-extra-tags":{db:"provider"}},access_token:{type:"string",description:"Access token value.","x-order":4,"x-oapi-codegen-extra-tags":{db:"access_token"}},refresh_token:{type:"string",description:"Refresh token value when applicable.","x-order":5,"x-oapi-codegen-extra-tags":{db:"refresh_token"}},name:{type:"string",description:"Human-readable token name.","x-order":6,"x-oapi-codegen-extra-tags":{db:"name"}},purpose:{type:"string",description:"Purpose for which the token was created.","x-order":7,"x-oapi-codegen-extra-tags":{db:"purpose"}},is_oauth:{type:"boolean",description:"Whether this entry represents an OAuth session.","x-order":8,"x-oapi-codegen-extra-tags":{db:"is_oauth"}},created_at:{"x-order":9,description:"Timestamp when the resource was created.","x-go-type":"time.Time",type:"string",format:"date-time","x-go-name":"CreatedAt","x-oapi-codegen-extra-tags":{db:"created_at",yaml:"created_at"},"x-go-type-skip-optional-pointer":true},updated_at:{"x-order":10,description:"Timestamp when the resource was updated.","x-go-type":"time.Time",type:"string",format:"date-time","x-go-name":"UpdatedAt","x-oapi-codegen-extra-tags":{db:"updated_at",yaml:"updated_at"},"x-go-type-skip-optional-pointer":true}}}}}},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"}}}}}}},"/api/identity/tokens/infinite":{get:{"x-internal":["cloud"],tags:["tokens"],summary:"Issue indefinite lifetime token",operationId:"issueIndefiniteLifetimeToken",description:"Creates a non-expiring user token for provider admin use cases.",parameters:[{name:"user_id",in:"query",description:"UUID of the user.",required:true,schema:{type:"string",format:"uuid",description:"A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"}}},{name:"provider",in:"query",description:"Remote provider.",required:true,schema:{type:"string"}}],responses:{200:{description:"Token generated",content:{"application/json":{schema:{type:"object",description:"A paginated list of tokens.",required:["tokens","total_count","page","page_size"],properties:{tokens:{type:"array",items:{"x-go-type":"UserToken",type:"object",description:"Represents a user-owned API token or OAuth session.",properties:{id:{description:"Unique identifier for the token.","x-order":1,"x-oapi-codegen-extra-tags":{db:"id"},type:"string",format:"uuid","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"}},user_id:{description:"UUID of the user who owns the token.","x-order":2,"x-oapi-codegen-extra-tags":{db:"user_id"},type:"string",format:"uuid","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"}},provider:{type:"string",description:"Authentication provider associated with the token.","x-order":3,"x-oapi-codegen-extra-tags":{db:"provider"}},access_token:{type:"string",description:"Access token value.","x-order":4,"x-oapi-codegen-extra-tags":{db:"access_token"}},refresh_token:{type:"string",description:"Refresh token value when applicable.","x-order":5,"x-oapi-codegen-extra-tags":{db:"refresh_token"}},name:{type:"string",description:"Human-readable token name.","x-order":6,"x-oapi-codegen-extra-tags":{db:"name"}},purpose:{type:"string",description:"Purpose for which the token was created.","x-order":7,"x-oapi-codegen-extra-tags":{db:"purpose"}},is_oauth:{type:"boolean",description:"Whether this entry represents an OAuth session.","x-order":8,"x-oapi-codegen-extra-tags":{db:"is_oauth"}},created_at:{"x-order":9,description:"Timestamp when the resource was created.","x-go-type":"time.Time",type:"string",format:"date-time","x-go-name":"CreatedAt","x-oapi-codegen-extra-tags":{db:"created_at",yaml:"created_at"},"x-go-type-skip-optional-pointer":true},updated_at:{"x-order":10,description:"Timestamp when the resource was updated.","x-go-type":"time.Time",type:"string",format:"date-time","x-go-name":"UpdatedAt","x-oapi-codegen-extra-tags":{db:"updated_at",yaml:"updated_at"},"x-go-type-skip-optional-pointer":true}}},"x-order":1},total_count:{type:"integer",description:"Total number of tokens across all pages.","x-order":2},page:{type:"integer",description:"Current page number (zero-based).","x-order":3},page_size:{type:"integer",description:"Number of tokens per page.","x-order":4}}}}}},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:{id:{name:"id",in:"path",description:"Token ID",required:true,schema:{type:"string",format:"uuid",description:"A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"}}},page:{name:"page",in:"query",description:"Get responses by page",schema:{type:"string"}},pagesize:{name:"pagesize",in:"query",description:"Get responses by pagesize",schema:{type:"string"}},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"}},isOAuth:{name:"isOAuth",in:"query",description:"Whether to retrieve OAuth-backed sessions instead of API tokens.",schema:{type:"boolean"}},name:{name:"name",in:"query",description:"Name of the token.",required:true,schema:{type:"string"}},purpose:{name:"purpose",in:"query",description:"Purpose for which the token is generated.",schema:{type:"string"}},tokenId:{name:"token_id",in:"query",description:"ID of the token.",required:true,schema:{type:"string",format:"uuid",description:"A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"}}},userId:{name:"user_id",in:"query",description:"UUID of the user.",required:true,schema:{type:"string",format:"uuid",description:"A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"}}},provider:{name:"provider",in:"query",description:"Remote provider.",required:true,schema:{type:"string"}}},schemas:{UserToken:{type:"object",description:"Represents a user-owned API token or OAuth session.",properties:{id:{description:"Unique identifier for the token.","x-order":1,"x-oapi-codegen-extra-tags":{db:"id"},type:"string",format:"uuid","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"}},user_id:{description:"UUID of the user who owns the token.","x-order":2,"x-oapi-codegen-extra-tags":{db:"user_id"},type:"string",format:"uuid","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"}},provider:{type:"string",description:"Authentication provider associated with the token.","x-order":3,"x-oapi-codegen-extra-tags":{db:"provider"}},access_token:{type:"string",description:"Access token value.","x-order":4,"x-oapi-codegen-extra-tags":{db:"access_token"}},refresh_token:{type:"string",description:"Refresh token value when applicable.","x-order":5,"x-oapi-codegen-extra-tags":{db:"refresh_token"}},name:{type:"string",description:"Human-readable token name.","x-order":6,"x-oapi-codegen-extra-tags":{db:"name"}},purpose:{type:"string",description:"Purpose for which the token was created.","x-order":7,"x-oapi-codegen-extra-tags":{db:"purpose"}},is_oauth:{type:"boolean",description:"Whether this entry represents an OAuth session.","x-order":8,"x-oapi-codegen-extra-tags":{db:"is_oauth"}},created_at:{"x-order":9,description:"Timestamp when the resource was created.","x-go-type":"time.Time",type:"string",format:"date-time","x-go-name":"CreatedAt","x-oapi-codegen-extra-tags":{db:"created_at",yaml:"created_at"},"x-go-type-skip-optional-pointer":true},updated_at:{"x-order":10,description:"Timestamp when the resource was updated.","x-go-type":"time.Time",type:"string",format:"date-time","x-go-name":"UpdatedAt","x-oapi-codegen-extra-tags":{db:"updated_at",yaml:"updated_at"},"x-go-type-skip-optional-pointer":true}}},TokenPage:{type:"object",description:"A paginated list of tokens.",required:["tokens","total_count","page","page_size"],properties:{tokens:{type:"array",items:{"x-go-type":"UserToken",type:"object",description:"Represents a user-owned API token or OAuth session.",properties:{id:{description:"Unique identifier for the token.","x-order":1,"x-oapi-codegen-extra-tags":{db:"id"},type:"string",format:"uuid","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"}},user_id:{description:"UUID of the user who owns the token.","x-order":2,"x-oapi-codegen-extra-tags":{db:"user_id"},type:"string",format:"uuid","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"}},provider:{type:"string",description:"Authentication provider associated with the token.","x-order":3,"x-oapi-codegen-extra-tags":{db:"provider"}},access_token:{type:"string",description:"Access token value.","x-order":4,"x-oapi-codegen-extra-tags":{db:"access_token"}},refresh_token:{type:"string",description:"Refresh token value when applicable.","x-order":5,"x-oapi-codegen-extra-tags":{db:"refresh_token"}},name:{type:"string",description:"Human-readable token name.","x-order":6,"x-oapi-codegen-extra-tags":{db:"name"}},purpose:{type:"string",description:"Purpose for which the token was created.","x-order":7,"x-oapi-codegen-extra-tags":{db:"purpose"}},is_oauth:{type:"boolean",description:"Whether this entry represents an OAuth session.","x-order":8,"x-oapi-codegen-extra-tags":{db:"is_oauth"}},created_at:{"x-order":9,description:"Timestamp when the resource was created.","x-go-type":"time.Time",type:"string",format:"date-time","x-go-name":"CreatedAt","x-oapi-codegen-extra-tags":{db:"created_at",yaml:"created_at"},"x-go-type-skip-optional-pointer":true},updated_at:{"x-order":10,description:"Timestamp when the resource was updated.","x-go-type":"time.Time",type:"string",format:"date-time","x-go-name":"UpdatedAt","x-oapi-codegen-extra-tags":{db:"updated_at",yaml:"updated_at"},"x-go-type-skip-optional-pointer":true}}},"x-order":1},total_count:{type:"integer",description:"Total number of tokens across all pages.","x-order":2},page:{type:"integer",description:"Current page number (zero-based).","x-order":3},page_size:{type:"integer",description:"Number of tokens per page.","x-order":4}}}}}},t=e;
2
2
  module.exports=t;
package/dist/constructs/v1beta1/token/TokenSchema.mjs CHANGED
@@ -1,2 +1,2 @@
1
- var e={openapi:"3.0.0",info:{title:"token",description:"Documentation for Meshery Cloud REST APIs for user tokens and sessions","x-deprecated":true,"x-superseded-by":"v1beta2",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"},version:"v1beta1"},servers:[{url:"https://cloud.layer5.io",description:"Meshery Cloud production server URL"},{url:"https://staging-cloud.layer5.io",description:"Meshery Cloud staging server URL"},{url:"http://localhost:9876",description:"Meshery Cloud development server URL"}],security:[{jwt:[]}],tags:[{name:"tokens",description:"Operations related to user tokens and sessions"}],paths:{"/api/identity/tokens":{get:{"x-internal":["cloud"],tags:["tokens"],summary:"Get tokens",operationId:"getUserTokens",description:"Retrieves tokens associated with the authenticated user.",parameters:[{name:"isOAuth",in:"query",description:"Whether to retrieve OAuth-backed sessions instead of API tokens.",schema:{type:"boolean"}},{name:"page",in:"query",description:"Get responses by page",schema:{type:"string"}},{name:"pagesize",in:"query",description:"Get responses by pagesize",schema:{type:"string"}},{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"}}],responses:{200:{description:"Tokens response",content:{"application/json":{schema:{type:"object",description:"A paginated list of tokens.",required:["tokens","total_count","page","page_size"],properties:{tokens:{type:"array",items:{"x-go-type":"UserToken",type:"object",description:"Represents a user-owned API token or OAuth session.",properties:{id:{description:"Unique identifier for the token.","x-order":1,"x-oapi-codegen-extra-tags":{db:"id"},type:"string",format:"uuid","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"}},user_id:{description:"UUID of the user who owns the token.","x-order":2,"x-oapi-codegen-extra-tags":{db:"user_id"},type:"string",format:"uuid","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"}},provider:{type:"string",description:"Authentication provider associated with the token.","x-order":3,"x-oapi-codegen-extra-tags":{db:"provider"}},access_token:{type:"string",description:"Access token value.","x-order":4,"x-oapi-codegen-extra-tags":{db:"access_token"}},refresh_token:{type:"string",description:"Refresh token value when applicable.","x-order":5,"x-oapi-codegen-extra-tags":{db:"refresh_token"}},name:{type:"string",description:"Human-readable token name.","x-order":6,"x-oapi-codegen-extra-tags":{db:"name"}},purpose:{type:"string",description:"Purpose for which the token was created.","x-order":7,"x-oapi-codegen-extra-tags":{db:"purpose"}},is_oauth:{type:"boolean",description:"Whether this entry represents an OAuth session.","x-order":8,"x-oapi-codegen-extra-tags":{db:"is_oauth"}},created_at:{"x-order":9,description:"Timestamp when the resource was created.","x-go-type":"time.Time",type:"string",format:"date-time","x-go-name":"CreatedAt","x-oapi-codegen-extra-tags":{db:"created_at",yaml:"created_at"},"x-go-type-skip-optional-pointer":true},updated_at:{"x-order":10,description:"Timestamp when the resource was updated.","x-go-type":"time.Time",type:"string",format:"date-time","x-go-name":"UpdatedAt","x-oapi-codegen-extra-tags":{db:"updated_at",yaml:"updated_at"},"x-go-type-skip-optional-pointer":true}}},"x-order":1},total_count:{type:"integer",description:"Total number of tokens across all pages.","x-order":2},page:{type:"integer",description:"Current page number (zero-based).","x-order":3},page_size:{type:"integer",description:"Number of tokens per page.","x-order":4}}}}}},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"}}}}}},post:{"x-internal":["cloud"],tags:["tokens"],summary:"Generate token",operationId:"generateToken",description:"Generates a token for the authenticated user.",parameters:[{name:"name",in:"query",description:"Name of the token.",required:true,schema:{type:"string"}},{name:"purpose",in:"query",description:"Purpose for which the token is generated.",schema:{type:"string"}}],responses:{200:{description:"Token generated",content:{"application/json":{schema:{type:"object",description:"A paginated list of tokens.",required:["tokens","total_count","page","page_size"],properties:{tokens:{type:"array",items:{"x-go-type":"UserToken",type:"object",description:"Represents a user-owned API token or OAuth session.",properties:{id:{description:"Unique identifier for the token.","x-order":1,"x-oapi-codegen-extra-tags":{db:"id"},type:"string",format:"uuid","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"}},user_id:{description:"UUID of the user who owns the token.","x-order":2,"x-oapi-codegen-extra-tags":{db:"user_id"},type:"string",format:"uuid","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"}},provider:{type:"string",description:"Authentication provider associated with the token.","x-order":3,"x-oapi-codegen-extra-tags":{db:"provider"}},access_token:{type:"string",description:"Access token value.","x-order":4,"x-oapi-codegen-extra-tags":{db:"access_token"}},refresh_token:{type:"string",description:"Refresh token value when applicable.","x-order":5,"x-oapi-codegen-extra-tags":{db:"refresh_token"}},name:{type:"string",description:"Human-readable token name.","x-order":6,"x-oapi-codegen-extra-tags":{db:"name"}},purpose:{type:"string",description:"Purpose for which the token was created.","x-order":7,"x-oapi-codegen-extra-tags":{db:"purpose"}},is_oauth:{type:"boolean",description:"Whether this entry represents an OAuth session.","x-order":8,"x-oapi-codegen-extra-tags":{db:"is_oauth"}},created_at:{"x-order":9,description:"Timestamp when the resource was created.","x-go-type":"time.Time",type:"string",format:"date-time","x-go-name":"CreatedAt","x-oapi-codegen-extra-tags":{db:"created_at",yaml:"created_at"},"x-go-type-skip-optional-pointer":true},updated_at:{"x-order":10,description:"Timestamp when the resource was updated.","x-go-type":"time.Time",type:"string",format:"date-time","x-go-name":"UpdatedAt","x-oapi-codegen-extra-tags":{db:"updated_at",yaml:"updated_at"},"x-go-type-skip-optional-pointer":true}}},"x-order":1},total_count:{type:"integer",description:"Total number of tokens across all pages.","x-order":2},page:{type:"integer",description:"Current page number (zero-based).","x-order":3},page_size:{type:"integer",description:"Number of tokens per page.","x-order":4}}}}}},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"}}}}}},delete:{"x-internal":["cloud"],tags:["tokens"],summary:"Delete token",operationId:"deleteUserToken",description:"Deletes a specific token for the authenticated user.",parameters:[{name:"token_id",in:"query",description:"ID of the token.",required:true,schema:{type:"string",format:"uuid",description:"A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"}}}],responses:{200:{description:"Token deleted",content:{"application/json":{schema:{type:"object",description:"A paginated list of tokens.",required:["tokens","total_count","page","page_size"],properties:{tokens:{type:"array",items:{"x-go-type":"UserToken",type:"object",description:"Represents a user-owned API token or OAuth session.",properties:{id:{description:"Unique identifier for the token.","x-order":1,"x-oapi-codegen-extra-tags":{db:"id"},type:"string",format:"uuid","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"}},user_id:{description:"UUID of the user who owns the token.","x-order":2,"x-oapi-codegen-extra-tags":{db:"user_id"},type:"string",format:"uuid","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"}},provider:{type:"string",description:"Authentication provider associated with the token.","x-order":3,"x-oapi-codegen-extra-tags":{db:"provider"}},access_token:{type:"string",description:"Access token value.","x-order":4,"x-oapi-codegen-extra-tags":{db:"access_token"}},refresh_token:{type:"string",description:"Refresh token value when applicable.","x-order":5,"x-oapi-codegen-extra-tags":{db:"refresh_token"}},name:{type:"string",description:"Human-readable token name.","x-order":6,"x-oapi-codegen-extra-tags":{db:"name"}},purpose:{type:"string",description:"Purpose for which the token was created.","x-order":7,"x-oapi-codegen-extra-tags":{db:"purpose"}},is_oauth:{type:"boolean",description:"Whether this entry represents an OAuth session.","x-order":8,"x-oapi-codegen-extra-tags":{db:"is_oauth"}},created_at:{"x-order":9,description:"Timestamp when the resource was created.","x-go-type":"time.Time",type:"string",format:"date-time","x-go-name":"CreatedAt","x-oapi-codegen-extra-tags":{db:"created_at",yaml:"created_at"},"x-go-type-skip-optional-pointer":true},updated_at:{"x-order":10,description:"Timestamp when the resource was updated.","x-go-type":"time.Time",type:"string",format:"date-time","x-go-name":"UpdatedAt","x-oapi-codegen-extra-tags":{db:"updated_at",yaml:"updated_at"},"x-go-type-skip-optional-pointer":true}}},"x-order":1},total_count:{type:"integer",description:"Total number of tokens across all pages.","x-order":2},page:{type:"integer",description:"Current page number (zero-based).","x-order":3},page_size:{type:"integer",description:"Number of tokens per page.","x-order":4}}}}}},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/tokens/{id}":{get:{"x-internal":["cloud"],tags:["tokens"],summary:"Get token by ID",operationId:"getUserTokensById",description:"Retrieves a specific token by its ID.",parameters:[{name:"id",in:"path",description:"Token ID",required:true,schema:{type:"string",format:"uuid",description:"A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"}}}],responses:{200:{description:"Token response",content:{"application/json":{schema:{type:"object",description:"Represents a user-owned API token or OAuth session.",properties:{id:{description:"Unique identifier for the token.","x-order":1,"x-oapi-codegen-extra-tags":{db:"id"},type:"string",format:"uuid","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"}},user_id:{description:"UUID of the user who owns the token.","x-order":2,"x-oapi-codegen-extra-tags":{db:"user_id"},type:"string",format:"uuid","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"}},provider:{type:"string",description:"Authentication provider associated with the token.","x-order":3,"x-oapi-codegen-extra-tags":{db:"provider"}},access_token:{type:"string",description:"Access token value.","x-order":4,"x-oapi-codegen-extra-tags":{db:"access_token"}},refresh_token:{type:"string",description:"Refresh token value when applicable.","x-order":5,"x-oapi-codegen-extra-tags":{db:"refresh_token"}},name:{type:"string",description:"Human-readable token name.","x-order":6,"x-oapi-codegen-extra-tags":{db:"name"}},purpose:{type:"string",description:"Purpose for which the token was created.","x-order":7,"x-oapi-codegen-extra-tags":{db:"purpose"}},is_oauth:{type:"boolean",description:"Whether this entry represents an OAuth session.","x-order":8,"x-oapi-codegen-extra-tags":{db:"is_oauth"}},created_at:{"x-order":9,description:"Timestamp when the resource was created.","x-go-type":"time.Time",type:"string",format:"date-time","x-go-name":"CreatedAt","x-oapi-codegen-extra-tags":{db:"created_at",yaml:"created_at"},"x-go-type-skip-optional-pointer":true},updated_at:{"x-order":10,description:"Timestamp when the resource was updated.","x-go-type":"time.Time",type:"string",format:"date-time","x-go-name":"UpdatedAt","x-oapi-codegen-extra-tags":{db:"updated_at",yaml:"updated_at"},"x-go-type-skip-optional-pointer":true}}}}}},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"}}}}}}},"/api/identity/tokens/infinite":{get:{"x-internal":["cloud"],tags:["tokens"],summary:"Issue indefinite lifetime token",operationId:"issueIndefiniteLifetimeToken",description:"Creates a non-expiring user token for provider admin use cases.",parameters:[{name:"user_id",in:"query",description:"UUID of the user.",required:true,schema:{type:"string",format:"uuid",description:"A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"}}},{name:"provider",in:"query",description:"Remote provider.",required:true,schema:{type:"string"}}],responses:{200:{description:"Token generated",content:{"application/json":{schema:{type:"object",description:"A paginated list of tokens.",required:["tokens","total_count","page","page_size"],properties:{tokens:{type:"array",items:{"x-go-type":"UserToken",type:"object",description:"Represents a user-owned API token or OAuth session.",properties:{id:{description:"Unique identifier for the token.","x-order":1,"x-oapi-codegen-extra-tags":{db:"id"},type:"string",format:"uuid","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"}},user_id:{description:"UUID of the user who owns the token.","x-order":2,"x-oapi-codegen-extra-tags":{db:"user_id"},type:"string",format:"uuid","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"}},provider:{type:"string",description:"Authentication provider associated with the token.","x-order":3,"x-oapi-codegen-extra-tags":{db:"provider"}},access_token:{type:"string",description:"Access token value.","x-order":4,"x-oapi-codegen-extra-tags":{db:"access_token"}},refresh_token:{type:"string",description:"Refresh token value when applicable.","x-order":5,"x-oapi-codegen-extra-tags":{db:"refresh_token"}},name:{type:"string",description:"Human-readable token name.","x-order":6,"x-oapi-codegen-extra-tags":{db:"name"}},purpose:{type:"string",description:"Purpose for which the token was created.","x-order":7,"x-oapi-codegen-extra-tags":{db:"purpose"}},is_oauth:{type:"boolean",description:"Whether this entry represents an OAuth session.","x-order":8,"x-oapi-codegen-extra-tags":{db:"is_oauth"}},created_at:{"x-order":9,description:"Timestamp when the resource was created.","x-go-type":"time.Time",type:"string",format:"date-time","x-go-name":"CreatedAt","x-oapi-codegen-extra-tags":{db:"created_at",yaml:"created_at"},"x-go-type-skip-optional-pointer":true},updated_at:{"x-order":10,description:"Timestamp when the resource was updated.","x-go-type":"time.Time",type:"string",format:"date-time","x-go-name":"UpdatedAt","x-oapi-codegen-extra-tags":{db:"updated_at",yaml:"updated_at"},"x-go-type-skip-optional-pointer":true}}},"x-order":1},total_count:{type:"integer",description:"Total number of tokens across all pages.","x-order":2},page:{type:"integer",description:"Current page number (zero-based).","x-order":3},page_size:{type:"integer",description:"Number of tokens per page.","x-order":4}}}}}},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:{id:{name:"id",in:"path",description:"Token ID",required:true,schema:{type:"string",format:"uuid",description:"A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"}}},page:{name:"page",in:"query",description:"Get responses by page",schema:{type:"string"}},pagesize:{name:"pagesize",in:"query",description:"Get responses by pagesize",schema:{type:"string"}},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"}},isOAuth:{name:"isOAuth",in:"query",description:"Whether to retrieve OAuth-backed sessions instead of API tokens.",schema:{type:"boolean"}},name:{name:"name",in:"query",description:"Name of the token.",required:true,schema:{type:"string"}},purpose:{name:"purpose",in:"query",description:"Purpose for which the token is generated.",schema:{type:"string"}},tokenId:{name:"token_id",in:"query",description:"ID of the token.",required:true,schema:{type:"string",format:"uuid",description:"A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"}}},userId:{name:"user_id",in:"query",description:"UUID of the user.",required:true,schema:{type:"string",format:"uuid",description:"A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"}}},provider:{name:"provider",in:"query",description:"Remote provider.",required:true,schema:{type:"string"}}},schemas:{UserToken:{type:"object",description:"Represents a user-owned API token or OAuth session.",properties:{id:{description:"Unique identifier for the token.","x-order":1,"x-oapi-codegen-extra-tags":{db:"id"},type:"string",format:"uuid","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"}},user_id:{description:"UUID of the user who owns the token.","x-order":2,"x-oapi-codegen-extra-tags":{db:"user_id"},type:"string",format:"uuid","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"}},provider:{type:"string",description:"Authentication provider associated with the token.","x-order":3,"x-oapi-codegen-extra-tags":{db:"provider"}},access_token:{type:"string",description:"Access token value.","x-order":4,"x-oapi-codegen-extra-tags":{db:"access_token"}},refresh_token:{type:"string",description:"Refresh token value when applicable.","x-order":5,"x-oapi-codegen-extra-tags":{db:"refresh_token"}},name:{type:"string",description:"Human-readable token name.","x-order":6,"x-oapi-codegen-extra-tags":{db:"name"}},purpose:{type:"string",description:"Purpose for which the token was created.","x-order":7,"x-oapi-codegen-extra-tags":{db:"purpose"}},is_oauth:{type:"boolean",description:"Whether this entry represents an OAuth session.","x-order":8,"x-oapi-codegen-extra-tags":{db:"is_oauth"}},created_at:{"x-order":9,description:"Timestamp when the resource was created.","x-go-type":"time.Time",type:"string",format:"date-time","x-go-name":"CreatedAt","x-oapi-codegen-extra-tags":{db:"created_at",yaml:"created_at"},"x-go-type-skip-optional-pointer":true},updated_at:{"x-order":10,description:"Timestamp when the resource was updated.","x-go-type":"time.Time",type:"string",format:"date-time","x-go-name":"UpdatedAt","x-oapi-codegen-extra-tags":{db:"updated_at",yaml:"updated_at"},"x-go-type-skip-optional-pointer":true}}},TokenPage:{type:"object",description:"A paginated list of tokens.",required:["tokens","total_count","page","page_size"],properties:{tokens:{type:"array",items:{"x-go-type":"UserToken",type:"object",description:"Represents a user-owned API token or OAuth session.",properties:{id:{description:"Unique identifier for the token.","x-order":1,"x-oapi-codegen-extra-tags":{db:"id"},type:"string",format:"uuid","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"}},user_id:{description:"UUID of the user who owns the token.","x-order":2,"x-oapi-codegen-extra-tags":{db:"user_id"},type:"string",format:"uuid","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"}},provider:{type:"string",description:"Authentication provider associated with the token.","x-order":3,"x-oapi-codegen-extra-tags":{db:"provider"}},access_token:{type:"string",description:"Access token value.","x-order":4,"x-oapi-codegen-extra-tags":{db:"access_token"}},refresh_token:{type:"string",description:"Refresh token value when applicable.","x-order":5,"x-oapi-codegen-extra-tags":{db:"refresh_token"}},name:{type:"string",description:"Human-readable token name.","x-order":6,"x-oapi-codegen-extra-tags":{db:"name"}},purpose:{type:"string",description:"Purpose for which the token was created.","x-order":7,"x-oapi-codegen-extra-tags":{db:"purpose"}},is_oauth:{type:"boolean",description:"Whether this entry represents an OAuth session.","x-order":8,"x-oapi-codegen-extra-tags":{db:"is_oauth"}},created_at:{"x-order":9,description:"Timestamp when the resource was created.","x-go-type":"time.Time",type:"string",format:"date-time","x-go-name":"CreatedAt","x-oapi-codegen-extra-tags":{db:"created_at",yaml:"created_at"},"x-go-type-skip-optional-pointer":true},updated_at:{"x-order":10,description:"Timestamp when the resource was updated.","x-go-type":"time.Time",type:"string",format:"date-time","x-go-name":"UpdatedAt","x-oapi-codegen-extra-tags":{db:"updated_at",yaml:"updated_at"},"x-go-type-skip-optional-pointer":true}}},"x-order":1},total_count:{type:"integer",description:"Total number of tokens across all pages.","x-order":2},page:{type:"integer",description:"Current page number (zero-based).","x-order":3},page_size:{type:"integer",description:"Number of tokens per page.","x-order":4}}}}}},t=e;
1
+ var e={openapi:"3.0.0",info:{title:"token",description:"Documentation for Meshery Cloud REST APIs for user tokens and sessions","x-deprecated":true,"x-superseded-by":"v1beta2",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"},version:"v1beta1"},servers:[{url:"https://cloud.meshery.io",description:"Meshery Cloud production server URL"},{url:"https://staging-cloud.meshery.io",description:"Meshery Cloud staging server URL"},{url:"http://localhost:9876",description:"Meshery Cloud development server URL"}],security:[{jwt:[]}],tags:[{name:"tokens",description:"Operations related to user tokens and sessions"}],paths:{"/api/identity/tokens":{get:{"x-internal":["cloud"],tags:["tokens"],summary:"Get tokens",operationId:"getUserTokens",description:"Retrieves tokens associated with the authenticated user.",parameters:[{name:"isOAuth",in:"query",description:"Whether to retrieve OAuth-backed sessions instead of API tokens.",schema:{type:"boolean"}},{name:"page",in:"query",description:"Get responses by page",schema:{type:"string"}},{name:"pagesize",in:"query",description:"Get responses by pagesize",schema:{type:"string"}},{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"}}],responses:{200:{description:"Tokens response",content:{"application/json":{schema:{type:"object",description:"A paginated list of tokens.",required:["tokens","total_count","page","page_size"],properties:{tokens:{type:"array",items:{"x-go-type":"UserToken",type:"object",description:"Represents a user-owned API token or OAuth session.",properties:{id:{description:"Unique identifier for the token.","x-order":1,"x-oapi-codegen-extra-tags":{db:"id"},type:"string",format:"uuid","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"}},user_id:{description:"UUID of the user who owns the token.","x-order":2,"x-oapi-codegen-extra-tags":{db:"user_id"},type:"string",format:"uuid","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"}},provider:{type:"string",description:"Authentication provider associated with the token.","x-order":3,"x-oapi-codegen-extra-tags":{db:"provider"}},access_token:{type:"string",description:"Access token value.","x-order":4,"x-oapi-codegen-extra-tags":{db:"access_token"}},refresh_token:{type:"string",description:"Refresh token value when applicable.","x-order":5,"x-oapi-codegen-extra-tags":{db:"refresh_token"}},name:{type:"string",description:"Human-readable token name.","x-order":6,"x-oapi-codegen-extra-tags":{db:"name"}},purpose:{type:"string",description:"Purpose for which the token was created.","x-order":7,"x-oapi-codegen-extra-tags":{db:"purpose"}},is_oauth:{type:"boolean",description:"Whether this entry represents an OAuth session.","x-order":8,"x-oapi-codegen-extra-tags":{db:"is_oauth"}},created_at:{"x-order":9,description:"Timestamp when the resource was created.","x-go-type":"time.Time",type:"string",format:"date-time","x-go-name":"CreatedAt","x-oapi-codegen-extra-tags":{db:"created_at",yaml:"created_at"},"x-go-type-skip-optional-pointer":true},updated_at:{"x-order":10,description:"Timestamp when the resource was updated.","x-go-type":"time.Time",type:"string",format:"date-time","x-go-name":"UpdatedAt","x-oapi-codegen-extra-tags":{db:"updated_at",yaml:"updated_at"},"x-go-type-skip-optional-pointer":true}}},"x-order":1},total_count:{type:"integer",description:"Total number of tokens across all pages.","x-order":2},page:{type:"integer",description:"Current page number (zero-based).","x-order":3},page_size:{type:"integer",description:"Number of tokens per page.","x-order":4}}}}}},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"}}}}}},post:{"x-internal":["cloud"],tags:["tokens"],summary:"Generate token",operationId:"generateToken",description:"Generates a token for the authenticated user.",parameters:[{name:"name",in:"query",description:"Name of the token.",required:true,schema:{type:"string"}},{name:"purpose",in:"query",description:"Purpose for which the token is generated.",schema:{type:"string"}}],responses:{200:{description:"Token generated",content:{"application/json":{schema:{type:"object",description:"A paginated list of tokens.",required:["tokens","total_count","page","page_size"],properties:{tokens:{type:"array",items:{"x-go-type":"UserToken",type:"object",description:"Represents a user-owned API token or OAuth session.",properties:{id:{description:"Unique identifier for the token.","x-order":1,"x-oapi-codegen-extra-tags":{db:"id"},type:"string",format:"uuid","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"}},user_id:{description:"UUID of the user who owns the token.","x-order":2,"x-oapi-codegen-extra-tags":{db:"user_id"},type:"string",format:"uuid","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"}},provider:{type:"string",description:"Authentication provider associated with the token.","x-order":3,"x-oapi-codegen-extra-tags":{db:"provider"}},access_token:{type:"string",description:"Access token value.","x-order":4,"x-oapi-codegen-extra-tags":{db:"access_token"}},refresh_token:{type:"string",description:"Refresh token value when applicable.","x-order":5,"x-oapi-codegen-extra-tags":{db:"refresh_token"}},name:{type:"string",description:"Human-readable token name.","x-order":6,"x-oapi-codegen-extra-tags":{db:"name"}},purpose:{type:"string",description:"Purpose for which the token was created.","x-order":7,"x-oapi-codegen-extra-tags":{db:"purpose"}},is_oauth:{type:"boolean",description:"Whether this entry represents an OAuth session.","x-order":8,"x-oapi-codegen-extra-tags":{db:"is_oauth"}},created_at:{"x-order":9,description:"Timestamp when the resource was created.","x-go-type":"time.Time",type:"string",format:"date-time","x-go-name":"CreatedAt","x-oapi-codegen-extra-tags":{db:"created_at",yaml:"created_at"},"x-go-type-skip-optional-pointer":true},updated_at:{"x-order":10,description:"Timestamp when the resource was updated.","x-go-type":"time.Time",type:"string",format:"date-time","x-go-name":"UpdatedAt","x-oapi-codegen-extra-tags":{db:"updated_at",yaml:"updated_at"},"x-go-type-skip-optional-pointer":true}}},"x-order":1},total_count:{type:"integer",description:"Total number of tokens across all pages.","x-order":2},page:{type:"integer",description:"Current page number (zero-based).","x-order":3},page_size:{type:"integer",description:"Number of tokens per page.","x-order":4}}}}}},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"}}}}}},delete:{"x-internal":["cloud"],tags:["tokens"],summary:"Delete token",operationId:"deleteUserToken",description:"Deletes a specific token for the authenticated user.",parameters:[{name:"token_id",in:"query",description:"ID of the token.",required:true,schema:{type:"string",format:"uuid",description:"A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"}}}],responses:{200:{description:"Token deleted",content:{"application/json":{schema:{type:"object",description:"A paginated list of tokens.",required:["tokens","total_count","page","page_size"],properties:{tokens:{type:"array",items:{"x-go-type":"UserToken",type:"object",description:"Represents a user-owned API token or OAuth session.",properties:{id:{description:"Unique identifier for the token.","x-order":1,"x-oapi-codegen-extra-tags":{db:"id"},type:"string",format:"uuid","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"}},user_id:{description:"UUID of the user who owns the token.","x-order":2,"x-oapi-codegen-extra-tags":{db:"user_id"},type:"string",format:"uuid","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"}},provider:{type:"string",description:"Authentication provider associated with the token.","x-order":3,"x-oapi-codegen-extra-tags":{db:"provider"}},access_token:{type:"string",description:"Access token value.","x-order":4,"x-oapi-codegen-extra-tags":{db:"access_token"}},refresh_token:{type:"string",description:"Refresh token value when applicable.","x-order":5,"x-oapi-codegen-extra-tags":{db:"refresh_token"}},name:{type:"string",description:"Human-readable token name.","x-order":6,"x-oapi-codegen-extra-tags":{db:"name"}},purpose:{type:"string",description:"Purpose for which the token was created.","x-order":7,"x-oapi-codegen-extra-tags":{db:"purpose"}},is_oauth:{type:"boolean",description:"Whether this entry represents an OAuth session.","x-order":8,"x-oapi-codegen-extra-tags":{db:"is_oauth"}},created_at:{"x-order":9,description:"Timestamp when the resource was created.","x-go-type":"time.Time",type:"string",format:"date-time","x-go-name":"CreatedAt","x-oapi-codegen-extra-tags":{db:"created_at",yaml:"created_at"},"x-go-type-skip-optional-pointer":true},updated_at:{"x-order":10,description:"Timestamp when the resource was updated.","x-go-type":"time.Time",type:"string",format:"date-time","x-go-name":"UpdatedAt","x-oapi-codegen-extra-tags":{db:"updated_at",yaml:"updated_at"},"x-go-type-skip-optional-pointer":true}}},"x-order":1},total_count:{type:"integer",description:"Total number of tokens across all pages.","x-order":2},page:{type:"integer",description:"Current page number (zero-based).","x-order":3},page_size:{type:"integer",description:"Number of tokens per page.","x-order":4}}}}}},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/tokens/{id}":{get:{"x-internal":["cloud"],tags:["tokens"],summary:"Get token by ID",operationId:"getUserTokensById",description:"Retrieves a specific token by its ID.",parameters:[{name:"id",in:"path",description:"Token ID",required:true,schema:{type:"string",format:"uuid",description:"A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"}}}],responses:{200:{description:"Token response",content:{"application/json":{schema:{type:"object",description:"Represents a user-owned API token or OAuth session.",properties:{id:{description:"Unique identifier for the token.","x-order":1,"x-oapi-codegen-extra-tags":{db:"id"},type:"string",format:"uuid","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"}},user_id:{description:"UUID of the user who owns the token.","x-order":2,"x-oapi-codegen-extra-tags":{db:"user_id"},type:"string",format:"uuid","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"}},provider:{type:"string",description:"Authentication provider associated with the token.","x-order":3,"x-oapi-codegen-extra-tags":{db:"provider"}},access_token:{type:"string",description:"Access token value.","x-order":4,"x-oapi-codegen-extra-tags":{db:"access_token"}},refresh_token:{type:"string",description:"Refresh token value when applicable.","x-order":5,"x-oapi-codegen-extra-tags":{db:"refresh_token"}},name:{type:"string",description:"Human-readable token name.","x-order":6,"x-oapi-codegen-extra-tags":{db:"name"}},purpose:{type:"string",description:"Purpose for which the token was created.","x-order":7,"x-oapi-codegen-extra-tags":{db:"purpose"}},is_oauth:{type:"boolean",description:"Whether this entry represents an OAuth session.","x-order":8,"x-oapi-codegen-extra-tags":{db:"is_oauth"}},created_at:{"x-order":9,description:"Timestamp when the resource was created.","x-go-type":"time.Time",type:"string",format:"date-time","x-go-name":"CreatedAt","x-oapi-codegen-extra-tags":{db:"created_at",yaml:"created_at"},"x-go-type-skip-optional-pointer":true},updated_at:{"x-order":10,description:"Timestamp when the resource was updated.","x-go-type":"time.Time",type:"string",format:"date-time","x-go-name":"UpdatedAt","x-oapi-codegen-extra-tags":{db:"updated_at",yaml:"updated_at"},"x-go-type-skip-optional-pointer":true}}}}}},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"}}}}}}},"/api/identity/tokens/infinite":{get:{"x-internal":["cloud"],tags:["tokens"],summary:"Issue indefinite lifetime token",operationId:"issueIndefiniteLifetimeToken",description:"Creates a non-expiring user token for provider admin use cases.",parameters:[{name:"user_id",in:"query",description:"UUID of the user.",required:true,schema:{type:"string",format:"uuid",description:"A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"}}},{name:"provider",in:"query",description:"Remote provider.",required:true,schema:{type:"string"}}],responses:{200:{description:"Token generated",content:{"application/json":{schema:{type:"object",description:"A paginated list of tokens.",required:["tokens","total_count","page","page_size"],properties:{tokens:{type:"array",items:{"x-go-type":"UserToken",type:"object",description:"Represents a user-owned API token or OAuth session.",properties:{id:{description:"Unique identifier for the token.","x-order":1,"x-oapi-codegen-extra-tags":{db:"id"},type:"string",format:"uuid","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"}},user_id:{description:"UUID of the user who owns the token.","x-order":2,"x-oapi-codegen-extra-tags":{db:"user_id"},type:"string",format:"uuid","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"}},provider:{type:"string",description:"Authentication provider associated with the token.","x-order":3,"x-oapi-codegen-extra-tags":{db:"provider"}},access_token:{type:"string",description:"Access token value.","x-order":4,"x-oapi-codegen-extra-tags":{db:"access_token"}},refresh_token:{type:"string",description:"Refresh token value when applicable.","x-order":5,"x-oapi-codegen-extra-tags":{db:"refresh_token"}},name:{type:"string",description:"Human-readable token name.","x-order":6,"x-oapi-codegen-extra-tags":{db:"name"}},purpose:{type:"string",description:"Purpose for which the token was created.","x-order":7,"x-oapi-codegen-extra-tags":{db:"purpose"}},is_oauth:{type:"boolean",description:"Whether this entry represents an OAuth session.","x-order":8,"x-oapi-codegen-extra-tags":{db:"is_oauth"}},created_at:{"x-order":9,description:"Timestamp when the resource was created.","x-go-type":"time.Time",type:"string",format:"date-time","x-go-name":"CreatedAt","x-oapi-codegen-extra-tags":{db:"created_at",yaml:"created_at"},"x-go-type-skip-optional-pointer":true},updated_at:{"x-order":10,description:"Timestamp when the resource was updated.","x-go-type":"time.Time",type:"string",format:"date-time","x-go-name":"UpdatedAt","x-oapi-codegen-extra-tags":{db:"updated_at",yaml:"updated_at"},"x-go-type-skip-optional-pointer":true}}},"x-order":1},total_count:{type:"integer",description:"Total number of tokens across all pages.","x-order":2},page:{type:"integer",description:"Current page number (zero-based).","x-order":3},page_size:{type:"integer",description:"Number of tokens per page.","x-order":4}}}}}},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:{id:{name:"id",in:"path",description:"Token ID",required:true,schema:{type:"string",format:"uuid",description:"A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"}}},page:{name:"page",in:"query",description:"Get responses by page",schema:{type:"string"}},pagesize:{name:"pagesize",in:"query",description:"Get responses by pagesize",schema:{type:"string"}},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"}},isOAuth:{name:"isOAuth",in:"query",description:"Whether to retrieve OAuth-backed sessions instead of API tokens.",schema:{type:"boolean"}},name:{name:"name",in:"query",description:"Name of the token.",required:true,schema:{type:"string"}},purpose:{name:"purpose",in:"query",description:"Purpose for which the token is generated.",schema:{type:"string"}},tokenId:{name:"token_id",in:"query",description:"ID of the token.",required:true,schema:{type:"string",format:"uuid",description:"A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"}}},userId:{name:"user_id",in:"query",description:"UUID of the user.",required:true,schema:{type:"string",format:"uuid",description:"A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"}}},provider:{name:"provider",in:"query",description:"Remote provider.",required:true,schema:{type:"string"}}},schemas:{UserToken:{type:"object",description:"Represents a user-owned API token or OAuth session.",properties:{id:{description:"Unique identifier for the token.","x-order":1,"x-oapi-codegen-extra-tags":{db:"id"},type:"string",format:"uuid","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"}},user_id:{description:"UUID of the user who owns the token.","x-order":2,"x-oapi-codegen-extra-tags":{db:"user_id"},type:"string",format:"uuid","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"}},provider:{type:"string",description:"Authentication provider associated with the token.","x-order":3,"x-oapi-codegen-extra-tags":{db:"provider"}},access_token:{type:"string",description:"Access token value.","x-order":4,"x-oapi-codegen-extra-tags":{db:"access_token"}},refresh_token:{type:"string",description:"Refresh token value when applicable.","x-order":5,"x-oapi-codegen-extra-tags":{db:"refresh_token"}},name:{type:"string",description:"Human-readable token name.","x-order":6,"x-oapi-codegen-extra-tags":{db:"name"}},purpose:{type:"string",description:"Purpose for which the token was created.","x-order":7,"x-oapi-codegen-extra-tags":{db:"purpose"}},is_oauth:{type:"boolean",description:"Whether this entry represents an OAuth session.","x-order":8,"x-oapi-codegen-extra-tags":{db:"is_oauth"}},created_at:{"x-order":9,description:"Timestamp when the resource was created.","x-go-type":"time.Time",type:"string",format:"date-time","x-go-name":"CreatedAt","x-oapi-codegen-extra-tags":{db:"created_at",yaml:"created_at"},"x-go-type-skip-optional-pointer":true},updated_at:{"x-order":10,description:"Timestamp when the resource was updated.","x-go-type":"time.Time",type:"string",format:"date-time","x-go-name":"UpdatedAt","x-oapi-codegen-extra-tags":{db:"updated_at",yaml:"updated_at"},"x-go-type-skip-optional-pointer":true}}},TokenPage:{type:"object",description:"A paginated list of tokens.",required:["tokens","total_count","page","page_size"],properties:{tokens:{type:"array",items:{"x-go-type":"UserToken",type:"object",description:"Represents a user-owned API token or OAuth session.",properties:{id:{description:"Unique identifier for the token.","x-order":1,"x-oapi-codegen-extra-tags":{db:"id"},type:"string",format:"uuid","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"}},user_id:{description:"UUID of the user who owns the token.","x-order":2,"x-oapi-codegen-extra-tags":{db:"user_id"},type:"string",format:"uuid","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"}},provider:{type:"string",description:"Authentication provider associated with the token.","x-order":3,"x-oapi-codegen-extra-tags":{db:"provider"}},access_token:{type:"string",description:"Access token value.","x-order":4,"x-oapi-codegen-extra-tags":{db:"access_token"}},refresh_token:{type:"string",description:"Refresh token value when applicable.","x-order":5,"x-oapi-codegen-extra-tags":{db:"refresh_token"}},name:{type:"string",description:"Human-readable token name.","x-order":6,"x-oapi-codegen-extra-tags":{db:"name"}},purpose:{type:"string",description:"Purpose for which the token was created.","x-order":7,"x-oapi-codegen-extra-tags":{db:"purpose"}},is_oauth:{type:"boolean",description:"Whether this entry represents an OAuth session.","x-order":8,"x-oapi-codegen-extra-tags":{db:"is_oauth"}},created_at:{"x-order":9,description:"Timestamp when the resource was created.","x-go-type":"time.Time",type:"string",format:"date-time","x-go-name":"CreatedAt","x-oapi-codegen-extra-tags":{db:"created_at",yaml:"created_at"},"x-go-type-skip-optional-pointer":true},updated_at:{"x-order":10,description:"Timestamp when the resource was updated.","x-go-type":"time.Time",type:"string",format:"date-time","x-go-name":"UpdatedAt","x-oapi-codegen-extra-tags":{db:"updated_at",yaml:"updated_at"},"x-go-type-skip-optional-pointer":true}}},"x-order":1},total_count:{type:"integer",description:"Total number of tokens across all pages.","x-order":2},page:{type:"integer",description:"Current page number (zero-based).","x-order":3},page_size:{type:"integer",description:"Number of tokens per page.","x-order":4}}}}}},t=e;
2
2
  export{t as default};
package/dist/constructs/v1beta2/credential/CredentialSchema.js CHANGED
@@ -1,4 +1,4 @@
1
- 'use strict';var e={openapi:"3.0.0",info:{title:"credential",description:"Documentation for Meshery Cloud REST APIs for Credentials",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"},version:"v1beta2"},servers:[{url:"https://cloud.layer5.io",description:"Meshery Cloud production server URL"},{url:"https://staging-cloud.layer5.io",description:"Meshery Cloud staging server URL"},{url:"http://localhost:9876",description:"Meshery Cloud development server URL"}],security:[{jwt:[]}],tags:[{name:"credentials",description:"Operations related to integration credentials"}],paths:{"/api/integrations/credentials":{get:{"x-internal":["cloud","meshery"],tags:["credentials"],summary:"Get credentials",operationId:"getUserCredentials",description:"Retrieves all credentials belonging to the authenticated user.",parameters:[{name:"page",in:"query",description:"Get responses by page",schema:{type:"string"}},{name:"pagesize",in:"query",description:"Get responses by pagesize",schema:{type:"string"}},{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"}}],responses:{200:{description:"Credentials response",content:{"application/json":{schema:{type:"object",description:"A paginated list of credentials.",required:["credentials","total_count","page","page_size"],properties:{credentials:{type:"array",items:{"x-go-type":"Credential",type:"object",additionalProperties:false,description:`Meshery Credentials store sensitive information such as API keys, tokens, and passwords used by connections to external systems.
1
+ 'use strict';var e={openapi:"3.0.0",info:{title:"credential",description:"Documentation for Meshery Cloud REST APIs for Credentials",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"},version:"v1beta2"},servers:[{url:"https://cloud.meshery.io",description:"Meshery Cloud production server URL"},{url:"https://staging-cloud.meshery.io",description:"Meshery Cloud staging server URL"},{url:"http://localhost:9876",description:"Meshery Cloud development server URL"}],security:[{jwt:[]}],tags:[{name:"credentials",description:"Operations related to integration credentials"}],paths:{"/api/integrations/credentials":{get:{"x-internal":["cloud","meshery"],tags:["credentials"],summary:"Get credentials",operationId:"getUserCredentials",description:"Retrieves all credentials belonging to the authenticated user.",parameters:[{name:"page",in:"query",description:"Get responses by page",schema:{type:"string"}},{name:"pagesize",in:"query",description:"Get responses by pagesize",schema:{type:"string"}},{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"}}],responses:{200:{description:"Credentials response",content:{"application/json":{schema:{type:"object",description:"A paginated list of credentials.",required:["credentials","total_count","page","page_size"],properties:{credentials:{type:"array",items:{"x-go-type":"Credential",type:"object",additionalProperties:false,description:`Meshery Credentials store sensitive information such as API keys, tokens, and passwords used by connections to external systems.
2
2
  `,required:["id","name","type","userId","createdAt","updatedAt"],properties:{id:{description:"Unique identifier for the credential.","x-order":1,"x-oapi-codegen-extra-tags":{db:"id"},type:"string",format:"uuid","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"}},name:{type:"string",description:"Human-readable name for the credential.","x-order":2,"x-oapi-codegen-extra-tags":{db:"name"},minLength:1,maxLength:255},userId:{description:"UUID of the user who owns this credential.","x-order":3,"x-oapi-codegen-extra-tags":{db:"user_id"},type:"string",format:"uuid","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"}},type:{type:"string",description:"Credential type (e.g. token, basic, AWS).","x-order":4,"x-oapi-codegen-extra-tags":{db:"type"},maxLength:255},secret:{type:"object",description:"Key-value pairs containing the sensitive credential data.","x-order":5,"x-go-type":"core.Map","x-go-type-import":{path:"github.com/meshery/schemas/models/core"},"x-go-type-skip-optional-pointer":true,"x-oapi-codegen-extra-tags":{db:"secret"}},createdAt:{type:"string",format:"date-time",description:"Timestamp when the credential was created.","x-go-type":"time.Time","x-go-type-skip-optional-pointer":true,"x-order":6,"x-oapi-codegen-extra-tags":{db:"created_at"}},updatedAt:{type:"string",format:"date-time",description:"Timestamp when the credential was last updated.","x-go-type":"time.Time","x-go-type-skip-optional-pointer":true,"x-order":7,"x-oapi-codegen-extra-tags":{db:"updated_at"}},deletedAt:{type:"string",format:"date-time",description:"Timestamp when the credential was soft-deleted.","x-go-type":"core.NullTime","x-go-type-import":{path:"github.com/meshery/schemas/models/core"},"x-go-type-skip-optional-pointer":true,"x-order":8,"x-oapi-codegen-extra-tags":{db:"deleted_at"}}}},"x-order":1,description:"The credentials returned on the current page."},total_count:{type:"integer",description:"Total number of credentials across all pages.","x-order":2,minimum:0},page:{type:"integer",description:"Current page number (zero-based).","x-order":3,minimum:0},page_size:{type:"integer",description:"Number of credentials per page.","x-order":4,minimum:1}}}}}},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"}}}}}},post:{"x-internal":["cloud","meshery"],tags:["credentials"],summary:"Save credential",operationId:"saveUserCredential",description:"Saves a new credential for the authenticated user.",requestBody:{required:true,content:{"application/json":{schema:{type:"object",description:"Payload for creating or updating a credential.",required:["name","type"],properties:{id:{description:"Existing credential ID for updates; omit on create.","x-order":1,"x-oapi-codegen-extra-tags":{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:"Human-readable name for the credential.","x-order":2,minLength:1,maxLength:255},userId:{description:"UUID of the user who owns this credential.","x-order":3,"x-oapi-codegen-extra-tags":{json:"userId,omitempty"},type:"string",format:"uuid","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"}},type:{type:"string",description:"Credential type (e.g. token, basic, AWS).","x-order":4,maxLength:255},secret:{type:"object",description:"Key-value pairs containing the sensitive credential data.","x-order":5,"x-go-type":"core.Map","x-go-type-import":{path:"github.com/meshery/schemas/models/core"},"x-go-type-skip-optional-pointer":true}}}}}},responses:{201:{description:"Credential saved",content:{"application/json":{schema:{type:"object",additionalProperties:false,description:`Meshery Credentials store sensitive information such as API keys, tokens, and passwords used by connections to external systems.
3
3
  `,required:["id","name","type","userId","createdAt","updatedAt"],properties:{id:{description:"Unique identifier for the credential.","x-order":1,"x-oapi-codegen-extra-tags":{db:"id"},type:"string",format:"uuid","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"}},name:{type:"string",description:"Human-readable name for the credential.","x-order":2,"x-oapi-codegen-extra-tags":{db:"name"},minLength:1,maxLength:255},userId:{description:"UUID of the user who owns this credential.","x-order":3,"x-oapi-codegen-extra-tags":{db:"user_id"},type:"string",format:"uuid","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"}},type:{type:"string",description:"Credential type (e.g. token, basic, AWS).","x-order":4,"x-oapi-codegen-extra-tags":{db:"type"},maxLength:255},secret:{type:"object",description:"Key-value pairs containing the sensitive credential data.","x-order":5,"x-go-type":"core.Map","x-go-type-import":{path:"github.com/meshery/schemas/models/core"},"x-go-type-skip-optional-pointer":true,"x-oapi-codegen-extra-tags":{db:"secret"}},createdAt:{type:"string",format:"date-time",description:"Timestamp when the credential was created.","x-go-type":"time.Time","x-go-type-skip-optional-pointer":true,"x-order":6,"x-oapi-codegen-extra-tags":{db:"created_at"}},updatedAt:{type:"string",format:"date-time",description:"Timestamp when the credential was last updated.","x-go-type":"time.Time","x-go-type-skip-optional-pointer":true,"x-order":7,"x-oapi-codegen-extra-tags":{db:"updated_at"}},deletedAt:{type:"string",format:"date-time",description:"Timestamp when the credential was soft-deleted.","x-go-type":"core.NullTime","x-go-type-import":{path:"github.com/meshery/schemas/models/core"},"x-go-type-skip-optional-pointer":true,"x-order":8,"x-oapi-codegen-extra-tags":{db:"deleted_at"}}}}}}},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"}}}}}},put:{"x-internal":["cloud","meshery"],tags:["credentials"],summary:"Update credential",operationId:"updateUserCredential",description:"Updates an existing credential for the authenticated user.",requestBody:{required:true,content:{"application/json":{schema:{type:"object",description:"Payload for creating or updating a credential.",required:["name","type"],properties:{id:{description:"Existing credential ID for updates; omit on create.","x-order":1,"x-oapi-codegen-extra-tags":{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:"Human-readable name for the credential.","x-order":2,minLength:1,maxLength:255},userId:{description:"UUID of the user who owns this credential.","x-order":3,"x-oapi-codegen-extra-tags":{json:"userId,omitempty"},type:"string",format:"uuid","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"}},type:{type:"string",description:"Credential type (e.g. token, basic, AWS).","x-order":4,maxLength:255},secret:{type:"object",description:"Key-value pairs containing the sensitive credential data.","x-order":5,"x-go-type":"core.Map","x-go-type-import":{path:"github.com/meshery/schemas/models/core"},"x-go-type-skip-optional-pointer":true}}}}}},responses:{200:{description:"Credential updated",content:{"application/json":{schema:{type:"object",additionalProperties:false,description:`Meshery Credentials store sensitive information such as API keys, tokens, and passwords used by connections to external systems.
4
4
  `,required:["id","name","type","userId","createdAt","updatedAt"],properties:{id:{description:"Unique identifier for the credential.","x-order":1,"x-oapi-codegen-extra-tags":{db:"id"},type:"string",format:"uuid","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"}},name:{type:"string",description:"Human-readable name for the credential.","x-order":2,"x-oapi-codegen-extra-tags":{db:"name"},minLength:1,maxLength:255},userId:{description:"UUID of the user who owns this credential.","x-order":3,"x-oapi-codegen-extra-tags":{db:"user_id"},type:"string",format:"uuid","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"}},type:{type:"string",description:"Credential type (e.g. token, basic, AWS).","x-order":4,"x-oapi-codegen-extra-tags":{db:"type"},maxLength:255},secret:{type:"object",description:"Key-value pairs containing the sensitive credential data.","x-order":5,"x-go-type":"core.Map","x-go-type-import":{path:"github.com/meshery/schemas/models/core"},"x-go-type-skip-optional-pointer":true,"x-oapi-codegen-extra-tags":{db:"secret"}},createdAt:{type:"string",format:"date-time",description:"Timestamp when the credential was created.","x-go-type":"time.Time","x-go-type-skip-optional-pointer":true,"x-order":6,"x-oapi-codegen-extra-tags":{db:"created_at"}},updatedAt:{type:"string",format:"date-time",description:"Timestamp when the credential was last updated.","x-go-type":"time.Time","x-go-type-skip-optional-pointer":true,"x-order":7,"x-oapi-codegen-extra-tags":{db:"updated_at"}},deletedAt:{type:"string",format:"date-time",description:"Timestamp when the credential was soft-deleted.","x-go-type":"core.NullTime","x-go-type-import":{path:"github.com/meshery/schemas/models/core"},"x-go-type-skip-optional-pointer":true,"x-order":8,"x-oapi-codegen-extra-tags":{db:"deleted_at"}}}}}}},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"}}}}}},delete:{"x-internal":["cloud","meshery"],tags:["credentials"],summary:"Delete credential",operationId:"deleteUserCredential",description:"Deletes a credential belonging to the authenticated user.",parameters:[{name:"credentialId",in:"query",description:"Credential ID",required:true,schema:{type:"string",format:"uuid",description:"A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"}}}],responses:{204:{description:"Credential deleted"},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"}}}}}}},"/api/integrations/credentials/{credentialId}":{get:{"x-internal":["cloud","meshery"],tags:["credentials"],summary:"Get credential by ID",operationId:"getCredentialById",description:"Retrieves a specific credential by its ID.",parameters:[{name:"credentialId",in:"path",description:"Credential ID",required:true,schema:{type:"string",format:"uuid",description:"A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"}}}],responses:{200:{description:"Credential response",content:{"application/json":{schema:{type:"object",additionalProperties:false,description:`Meshery Credentials store sensitive information such as API keys, tokens, and passwords used by connections to external systems.
package/dist/constructs/v1beta2/credential/CredentialSchema.mjs CHANGED
@@ -1,4 +1,4 @@
1
- var e={openapi:"3.0.0",info:{title:"credential",description:"Documentation for Meshery Cloud REST APIs for Credentials",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"},version:"v1beta2"},servers:[{url:"https://cloud.layer5.io",description:"Meshery Cloud production server URL"},{url:"https://staging-cloud.layer5.io",description:"Meshery Cloud staging server URL"},{url:"http://localhost:9876",description:"Meshery Cloud development server URL"}],security:[{jwt:[]}],tags:[{name:"credentials",description:"Operations related to integration credentials"}],paths:{"/api/integrations/credentials":{get:{"x-internal":["cloud","meshery"],tags:["credentials"],summary:"Get credentials",operationId:"getUserCredentials",description:"Retrieves all credentials belonging to the authenticated user.",parameters:[{name:"page",in:"query",description:"Get responses by page",schema:{type:"string"}},{name:"pagesize",in:"query",description:"Get responses by pagesize",schema:{type:"string"}},{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"}}],responses:{200:{description:"Credentials response",content:{"application/json":{schema:{type:"object",description:"A paginated list of credentials.",required:["credentials","total_count","page","page_size"],properties:{credentials:{type:"array",items:{"x-go-type":"Credential",type:"object",additionalProperties:false,description:`Meshery Credentials store sensitive information such as API keys, tokens, and passwords used by connections to external systems.
1
+ var e={openapi:"3.0.0",info:{title:"credential",description:"Documentation for Meshery Cloud REST APIs for Credentials",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"},version:"v1beta2"},servers:[{url:"https://cloud.meshery.io",description:"Meshery Cloud production server URL"},{url:"https://staging-cloud.meshery.io",description:"Meshery Cloud staging server URL"},{url:"http://localhost:9876",description:"Meshery Cloud development server URL"}],security:[{jwt:[]}],tags:[{name:"credentials",description:"Operations related to integration credentials"}],paths:{"/api/integrations/credentials":{get:{"x-internal":["cloud","meshery"],tags:["credentials"],summary:"Get credentials",operationId:"getUserCredentials",description:"Retrieves all credentials belonging to the authenticated user.",parameters:[{name:"page",in:"query",description:"Get responses by page",schema:{type:"string"}},{name:"pagesize",in:"query",description:"Get responses by pagesize",schema:{type:"string"}},{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"}}],responses:{200:{description:"Credentials response",content:{"application/json":{schema:{type:"object",description:"A paginated list of credentials.",required:["credentials","total_count","page","page_size"],properties:{credentials:{type:"array",items:{"x-go-type":"Credential",type:"object",additionalProperties:false,description:`Meshery Credentials store sensitive information such as API keys, tokens, and passwords used by connections to external systems.
2
2
  `,required:["id","name","type","userId","createdAt","updatedAt"],properties:{id:{description:"Unique identifier for the credential.","x-order":1,"x-oapi-codegen-extra-tags":{db:"id"},type:"string",format:"uuid","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"}},name:{type:"string",description:"Human-readable name for the credential.","x-order":2,"x-oapi-codegen-extra-tags":{db:"name"},minLength:1,maxLength:255},userId:{description:"UUID of the user who owns this credential.","x-order":3,"x-oapi-codegen-extra-tags":{db:"user_id"},type:"string",format:"uuid","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"}},type:{type:"string",description:"Credential type (e.g. token, basic, AWS).","x-order":4,"x-oapi-codegen-extra-tags":{db:"type"},maxLength:255},secret:{type:"object",description:"Key-value pairs containing the sensitive credential data.","x-order":5,"x-go-type":"core.Map","x-go-type-import":{path:"github.com/meshery/schemas/models/core"},"x-go-type-skip-optional-pointer":true,"x-oapi-codegen-extra-tags":{db:"secret"}},createdAt:{type:"string",format:"date-time",description:"Timestamp when the credential was created.","x-go-type":"time.Time","x-go-type-skip-optional-pointer":true,"x-order":6,"x-oapi-codegen-extra-tags":{db:"created_at"}},updatedAt:{type:"string",format:"date-time",description:"Timestamp when the credential was last updated.","x-go-type":"time.Time","x-go-type-skip-optional-pointer":true,"x-order":7,"x-oapi-codegen-extra-tags":{db:"updated_at"}},deletedAt:{type:"string",format:"date-time",description:"Timestamp when the credential was soft-deleted.","x-go-type":"core.NullTime","x-go-type-import":{path:"github.com/meshery/schemas/models/core"},"x-go-type-skip-optional-pointer":true,"x-order":8,"x-oapi-codegen-extra-tags":{db:"deleted_at"}}}},"x-order":1,description:"The credentials returned on the current page."},total_count:{type:"integer",description:"Total number of credentials across all pages.","x-order":2,minimum:0},page:{type:"integer",description:"Current page number (zero-based).","x-order":3,minimum:0},page_size:{type:"integer",description:"Number of credentials per page.","x-order":4,minimum:1}}}}}},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"}}}}}},post:{"x-internal":["cloud","meshery"],tags:["credentials"],summary:"Save credential",operationId:"saveUserCredential",description:"Saves a new credential for the authenticated user.",requestBody:{required:true,content:{"application/json":{schema:{type:"object",description:"Payload for creating or updating a credential.",required:["name","type"],properties:{id:{description:"Existing credential ID for updates; omit on create.","x-order":1,"x-oapi-codegen-extra-tags":{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:"Human-readable name for the credential.","x-order":2,minLength:1,maxLength:255},userId:{description:"UUID of the user who owns this credential.","x-order":3,"x-oapi-codegen-extra-tags":{json:"userId,omitempty"},type:"string",format:"uuid","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"}},type:{type:"string",description:"Credential type (e.g. token, basic, AWS).","x-order":4,maxLength:255},secret:{type:"object",description:"Key-value pairs containing the sensitive credential data.","x-order":5,"x-go-type":"core.Map","x-go-type-import":{path:"github.com/meshery/schemas/models/core"},"x-go-type-skip-optional-pointer":true}}}}}},responses:{201:{description:"Credential saved",content:{"application/json":{schema:{type:"object",additionalProperties:false,description:`Meshery Credentials store sensitive information such as API keys, tokens, and passwords used by connections to external systems.
3
3
  `,required:["id","name","type","userId","createdAt","updatedAt"],properties:{id:{description:"Unique identifier for the credential.","x-order":1,"x-oapi-codegen-extra-tags":{db:"id"},type:"string",format:"uuid","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"}},name:{type:"string",description:"Human-readable name for the credential.","x-order":2,"x-oapi-codegen-extra-tags":{db:"name"},minLength:1,maxLength:255},userId:{description:"UUID of the user who owns this credential.","x-order":3,"x-oapi-codegen-extra-tags":{db:"user_id"},type:"string",format:"uuid","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"}},type:{type:"string",description:"Credential type (e.g. token, basic, AWS).","x-order":4,"x-oapi-codegen-extra-tags":{db:"type"},maxLength:255},secret:{type:"object",description:"Key-value pairs containing the sensitive credential data.","x-order":5,"x-go-type":"core.Map","x-go-type-import":{path:"github.com/meshery/schemas/models/core"},"x-go-type-skip-optional-pointer":true,"x-oapi-codegen-extra-tags":{db:"secret"}},createdAt:{type:"string",format:"date-time",description:"Timestamp when the credential was created.","x-go-type":"time.Time","x-go-type-skip-optional-pointer":true,"x-order":6,"x-oapi-codegen-extra-tags":{db:"created_at"}},updatedAt:{type:"string",format:"date-time",description:"Timestamp when the credential was last updated.","x-go-type":"time.Time","x-go-type-skip-optional-pointer":true,"x-order":7,"x-oapi-codegen-extra-tags":{db:"updated_at"}},deletedAt:{type:"string",format:"date-time",description:"Timestamp when the credential was soft-deleted.","x-go-type":"core.NullTime","x-go-type-import":{path:"github.com/meshery/schemas/models/core"},"x-go-type-skip-optional-pointer":true,"x-order":8,"x-oapi-codegen-extra-tags":{db:"deleted_at"}}}}}}},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"}}}}}},put:{"x-internal":["cloud","meshery"],tags:["credentials"],summary:"Update credential",operationId:"updateUserCredential",description:"Updates an existing credential for the authenticated user.",requestBody:{required:true,content:{"application/json":{schema:{type:"object",description:"Payload for creating or updating a credential.",required:["name","type"],properties:{id:{description:"Existing credential ID for updates; omit on create.","x-order":1,"x-oapi-codegen-extra-tags":{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:"Human-readable name for the credential.","x-order":2,minLength:1,maxLength:255},userId:{description:"UUID of the user who owns this credential.","x-order":3,"x-oapi-codegen-extra-tags":{json:"userId,omitempty"},type:"string",format:"uuid","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"}},type:{type:"string",description:"Credential type (e.g. token, basic, AWS).","x-order":4,maxLength:255},secret:{type:"object",description:"Key-value pairs containing the sensitive credential data.","x-order":5,"x-go-type":"core.Map","x-go-type-import":{path:"github.com/meshery/schemas/models/core"},"x-go-type-skip-optional-pointer":true}}}}}},responses:{200:{description:"Credential updated",content:{"application/json":{schema:{type:"object",additionalProperties:false,description:`Meshery Credentials store sensitive information such as API keys, tokens, and passwords used by connections to external systems.
4
4
  `,required:["id","name","type","userId","createdAt","updatedAt"],properties:{id:{description:"Unique identifier for the credential.","x-order":1,"x-oapi-codegen-extra-tags":{db:"id"},type:"string",format:"uuid","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"}},name:{type:"string",description:"Human-readable name for the credential.","x-order":2,"x-oapi-codegen-extra-tags":{db:"name"},minLength:1,maxLength:255},userId:{description:"UUID of the user who owns this credential.","x-order":3,"x-oapi-codegen-extra-tags":{db:"user_id"},type:"string",format:"uuid","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"}},type:{type:"string",description:"Credential type (e.g. token, basic, AWS).","x-order":4,"x-oapi-codegen-extra-tags":{db:"type"},maxLength:255},secret:{type:"object",description:"Key-value pairs containing the sensitive credential data.","x-order":5,"x-go-type":"core.Map","x-go-type-import":{path:"github.com/meshery/schemas/models/core"},"x-go-type-skip-optional-pointer":true,"x-oapi-codegen-extra-tags":{db:"secret"}},createdAt:{type:"string",format:"date-time",description:"Timestamp when the credential was created.","x-go-type":"time.Time","x-go-type-skip-optional-pointer":true,"x-order":6,"x-oapi-codegen-extra-tags":{db:"created_at"}},updatedAt:{type:"string",format:"date-time",description:"Timestamp when the credential was last updated.","x-go-type":"time.Time","x-go-type-skip-optional-pointer":true,"x-order":7,"x-oapi-codegen-extra-tags":{db:"updated_at"}},deletedAt:{type:"string",format:"date-time",description:"Timestamp when the credential was soft-deleted.","x-go-type":"core.NullTime","x-go-type-import":{path:"github.com/meshery/schemas/models/core"},"x-go-type-skip-optional-pointer":true,"x-order":8,"x-oapi-codegen-extra-tags":{db:"deleted_at"}}}}}}},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"}}}}}},delete:{"x-internal":["cloud","meshery"],tags:["credentials"],summary:"Delete credential",operationId:"deleteUserCredential",description:"Deletes a credential belonging to the authenticated user.",parameters:[{name:"credentialId",in:"query",description:"Credential ID",required:true,schema:{type:"string",format:"uuid",description:"A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"}}}],responses:{204:{description:"Credential deleted"},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"}}}}}}},"/api/integrations/credentials/{credentialId}":{get:{"x-internal":["cloud","meshery"],tags:["credentials"],summary:"Get credential by ID",operationId:"getCredentialById",description:"Retrieves a specific credential by its ID.",parameters:[{name:"credentialId",in:"path",description:"Credential ID",required:true,schema:{type:"string",format:"uuid",description:"A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"}}}],responses:{200:{description:"Credential response",content:{"application/json":{schema:{type:"object",additionalProperties:false,description:`Meshery Credentials store sensitive information such as API keys, tokens, and passwords used by connections to external systems.