Namirasoft Credential API V1
Namira Software Corporation Credential API Version 1 (1.4.40)
Install
To use this cli, we need to first Install Nodejs, then run the following command.
npm i -g namirasoft-credential-api-v1
Commands
Healthz
Get
Returns the application health status
ns-credential healthz get
Health
Liveness
Returns the application liveness status
ns-credential health liveness
Readiness
Returns the application readiness status
ns-credential health readiness
Metrics
Get
Returns the application metrics
ns-credential metrics get
Value
List
Returns the value list of a given table and column
ns-credential value list {table} {column} {search} {field_id} {limit}
Credential
List
Returns the credential list
ns-credential credential list {filters} {page} {size} {sorts} {all_workspaces}
_GetFor
Returns a credential by an id for an user_id
ns-credential credential _getfor {user_id} {id}
Get
Returns a credential by an id
ns-credential credential get {id}
Protocol
List
Returns the protocol list
ns-credential protocol list {filters} {page} {size} {sorts} {all_workspaces}
_GetFor
Returns a protocol by an id for an user_id
ns-credential protocol _getfor {user_id} {id}
Get
Returns a protocol by an id
ns-credential protocol get {id}
Cloud
List
Returns the cloud list
ns-credential cloud list {filters} {page} {size} {sorts} {all_workspaces}
_GetFor
Returns a cloud by an id for an user_id
ns-credential cloud _getfor {user_id} {id}
Get
Returns a cloud by an id
ns-credential cloud get {id}
SourceControl
List
Returns the source control list
ns-credential sourcecontrol list {filters} {page} {size} {sorts} {all_workspaces}
_GetFor
Returns a source control by an id for an user_id
ns-credential sourcecontrol _getfor {user_id} {id}
Get
Returns a source control by an id
ns-credential sourcecontrol get {id}
AWSCategory
List
Returns the aws category list
ns-credential awscategory list {filters} {page} {size} {sorts} {all_workspaces}
Get
Returns a aws category by id.
ns-credential awscategory get {id}
Create
Creates a new aws category for an entity
ns-credential awscategory create
--category_id (String)
Delete
Deletes a aws category by an id.
ns-credential awscategory delete {id}
AWSField
List
Returns the aws field list
ns-credential awsfield list {filters} {page} {size} {sorts} {all_workspaces}
Get
Returns a aws field by id.
ns-credential awsfield get {id}
Create
Creates a new aws field for an entity
ns-credential awsfield create
--field_id (String)
--value (Any)
Update
Updates a aws field by an id for an entity
ns-credential awsfield update {id}
--field_id (String)
--value (Any)
Delete
Deletes a aws field by an id.
ns-credential awsfield delete {id}
AWSTag
List
Returns the aws tag list
ns-credential awstag list {filters} {page} {size} {sorts} {all_workspaces}
Get
Returns a aws tag by id.
ns-credential awstag get {id}
Create
Creates a new aws tag for an entity
ns-credential awstag create
--name (String)
--value (String)
Update
Updates a aws tag by an id for an entity
ns-credential awstag update {id}
--name (String)
--value (String)
Delete
Deletes a aws tag by an id.
ns-credential awstag delete {id}
AWS
List
Returns the aws list
ns-credential aws list {filters} {page} {size} {sorts} {all_workspaces}
_GetFor
Returns an aws by an id for an user_id
ns-credential aws _getfor {user_id} {id}
Get
Returns an aws by an id
ns-credential aws get {id}
Create
Creates a new aws
ns-credential aws create
--access_key (String)
--secret_key (String)
--workspace_id (String)
--name (String)
--description (String)
--aws_category (Array)
--aws_field (Array)
--aws_tag (Array)
Update
Updates an aws by an id
ns-credential aws update {id}
--access_key (String)
--secret_key (String)
--workspace_id (String)
--name (String)
--description (String)
--aws_category (Array)
--aws_field (Array)
--aws_tag (Array)
Delete
Deletes an aws by an id
ns-credential aws delete {id}
AzureCategory
List
Returns the azure category list
ns-credential azurecategory list {filters} {page} {size} {sorts} {all_workspaces}
Get
Returns a azure category by id.
ns-credential azurecategory get {id}
Create
Creates a new azure category for an entity
ns-credential azurecategory create
--category_id (String)
Delete
Deletes a azure category by an id.
ns-credential azurecategory delete {id}
AzureField
List
Returns the azure field list
ns-credential azurefield list {filters} {page} {size} {sorts} {all_workspaces}
Get
Returns a azure field by id.
ns-credential azurefield get {id}
Create
Creates a new azure field for an entity
ns-credential azurefield create
--field_id (String)
--value (Any)
Update
Updates a azure field by an id for an entity
ns-credential azurefield update {id}
--field_id (String)
--value (Any)
Delete
Deletes a azure field by an id.
ns-credential azurefield delete {id}
AzureTag
List
Returns the azure tag list
ns-credential azuretag list {filters} {page} {size} {sorts} {all_workspaces}
Get
Returns a azure tag by id.
ns-credential azuretag get {id}
Create
Creates a new azure tag for an entity
ns-credential azuretag create
--name (String)
--value (String)
Update
Updates a azure tag by an id for an entity
ns-credential azuretag update {id}
--name (String)
--value (String)
Delete
Deletes a azure tag by an id.
ns-credential azuretag delete {id}
Azure
List
Returns the azure list
ns-credential azure list {filters} {page} {size} {sorts} {all_workspaces}
_GetFor
Returns an azure by an id for an user_id
ns-credential azure _getfor {user_id} {id}
Get
Returns an azure by an id
ns-credential azure get {id}
Create
Creates a new azure
ns-credential azure create
--tenant_id (String)
--client_id (String)
--client_secret (String)
--workspace_id (String)
--name (String)
--description (String)
--azure_category (Array)
--azure_field (Array)
--azure_tag (Array)
Update
Updates an azure by an id
ns-credential azure update {id}
--tenant_id (String)
--client_id (String)
--client_secret (String)
--workspace_id (String)
--name (String)
--description (String)
--azure_category (Array)
--azure_field (Array)
--azure_tag (Array)
Delete
Deletes an azure by an id
ns-credential azure delete {id}
GCPCategory
List
Returns the gcp category list
ns-credential gcpcategory list {filters} {page} {size} {sorts} {all_workspaces}
Get
Returns a gcp category by id.
ns-credential gcpcategory get {id}
Create
Creates a new gcp category for an entity
ns-credential gcpcategory create
--category_id (String)
Delete
Deletes a gcp category by an id.
ns-credential gcpcategory delete {id}
GCPField
List
Returns the gcp field list
ns-credential gcpfield list {filters} {page} {size} {sorts} {all_workspaces}
Get
Returns a gcp field by id.
ns-credential gcpfield get {id}
Create
Creates a new gcp field for an entity
ns-credential gcpfield create
--field_id (String)
--value (Any)
Update
Updates a gcp field by an id for an entity
ns-credential gcpfield update {id}
--field_id (String)
--value (Any)
Delete
Deletes a gcp field by an id.
ns-credential gcpfield delete {id}
GCPTag
List
Returns the gcp tag list
ns-credential gcptag list {filters} {page} {size} {sorts} {all_workspaces}
Get
Returns a gcp tag by id.
ns-credential gcptag get {id}
Create
Creates a new gcp tag for an entity
ns-credential gcptag create
--name (String)
--value (String)
Update
Updates a gcp tag by an id for an entity
ns-credential gcptag update {id}
--name (String)
--value (String)
Delete
Deletes a gcp tag by an id.
ns-credential gcptag delete {id}
GCP
List
Returns the gcp list
ns-credential gcp list {filters} {page} {size} {sorts} {all_workspaces}
_GetFor
Returns an gcp by an id for an user_id
ns-credential gcp _getfor {user_id} {id}
Get
Returns a gcp by an id
ns-credential gcp get {id}
Create
Creates a new gcp
ns-credential gcp create
--credentials (String)
--workspace_id (String)
--name (String)
--description (String)
--gcp_category (Array)
--gcp_field (Array)
--gcp_tag (Array)
Update
Updates a gcp by an id
ns-credential gcp update {id}
--credentials (String)
--workspace_id (String)
--name (String)
--description (String)
--gcp_category (Array)
--gcp_field (Array)
--gcp_tag (Array)
Delete
Deletes a gcp by an id
ns-credential gcp delete {id}
GitHubCategory
List
Returns the git hub category list
ns-credential githubcategory list {filters} {page} {size} {sorts} {all_workspaces}
Get
Returns a git hub category by id.
ns-credential githubcategory get {id}
Create
Creates a new git hub category for an entity
ns-credential githubcategory create
--category_id (String)
Delete
Deletes a git hub category by an id.
ns-credential githubcategory delete {id}
GitHubField
List
Returns the git hub field list
ns-credential githubfield list {filters} {page} {size} {sorts} {all_workspaces}
Get
Returns a git hub field by id.
ns-credential githubfield get {id}
Create
Creates a new git hub field for an entity
ns-credential githubfield create
--field_id (String)
--value (Any)
Update
Updates a git hub field by an id for an entity
ns-credential githubfield update {id}
--field_id (String)
--value (Any)
Delete
Deletes a git hub field by an id.
ns-credential githubfield delete {id}
GitHubTag
List
Returns the git hub tag list
ns-credential githubtag list {filters} {page} {size} {sorts} {all_workspaces}
Get
Returns a git hub tag by id.
ns-credential githubtag get {id}
Create
Creates a new git hub tag for an entity
ns-credential githubtag create
--name (String)
--value (String)
Update
Updates a git hub tag by an id for an entity
ns-credential githubtag update {id}
--name (String)
--value (String)
Delete
Deletes a git hub tag by an id.
ns-credential githubtag delete {id}
GitHub
List
Returns the git hub list
ns-credential github list {filters} {page} {size} {sorts} {all_workspaces}
_GetFor
Returns a git hub by an id for an user_id
ns-credential github _getfor {user_id} {id}
Get
Returns a git hub by an id
ns-credential github get {id}
Create
Creates a new git hub
ns-credential github create
--host (String)
--type (Enum)
--username (String)
--password (String)
--pat_classic_token (String)
--pat_fine_graned_token (String)
--oauthapp_client_id (String)
--oauthapp_client_secret (String)
--oauthapp_refresh_token (String)
--oauthapp_access_token (String)
--githubapp_installation_id (String)
--githubapp_jwt (String)
--githubapp_token (String)
--ssh_publickey (String)
--ssh_privatekey (String)
--workspace_id (String)
--name (String)
--description (String)
--git_hub_category (Array)
--git_hub_field (Array)
--git_hub_tag (Array)
Update
Updates a git hub by an id
ns-credential github update {id}
--host (String)
--username (String)
--password (String)
--pat_classic_token (String)
--pat_fine_graned_token (String)
--oauthapp_client_id (String)
--oauthapp_client_secret (String)
--oauthapp_refresh_token (String)
--oauthapp_access_token (String)
--githubapp_installation_id (String)
--githubapp_jwt (String)
--githubapp_token (String)
--ssh_publickey (String)
--ssh_privatekey (String)
--workspace_id (String)
--name (String)
--description (String)
--git_hub_category (Array)
--git_hub_field (Array)
--git_hub_tag (Array)
Delete
Deletes a git hub by an id
ns-credential github delete {id}
GitLabCategory
List
Returns the git lab category list
ns-credential gitlabcategory list {filters} {page} {size} {sorts} {all_workspaces}
Get
Returns a git lab category by id.
ns-credential gitlabcategory get {id}
Create
Creates a new git lab category for an entity
ns-credential gitlabcategory create
--category_id (String)
Delete
Deletes a git lab category by an id.
ns-credential gitlabcategory delete {id}
GitLabField
List
Returns the git lab field list
ns-credential gitlabfield list {filters} {page} {size} {sorts} {all_workspaces}
Get
Returns a git lab field by id.
ns-credential gitlabfield get {id}
Create
Creates a new git lab field for an entity
ns-credential gitlabfield create
--field_id (String)
--value (Any)
Update
Updates a git lab field by an id for an entity
ns-credential gitlabfield update {id}
--field_id (String)
--value (Any)
Delete
Deletes a git lab field by an id.
ns-credential gitlabfield delete {id}
GitLabTag
List
Returns the git lab tag list
ns-credential gitlabtag list {filters} {page} {size} {sorts} {all_workspaces}
Get
Returns a git lab tag by id.
ns-credential gitlabtag get {id}
Create
Creates a new git lab tag for an entity
ns-credential gitlabtag create
--name (String)
--value (String)
Update
Updates a git lab tag by an id for an entity
ns-credential gitlabtag update {id}
--name (String)
--value (String)
Delete
Deletes a git lab tag by an id.
ns-credential gitlabtag delete {id}
GitLab
List
Returns the git lab list
ns-credential gitlab list {filters} {page} {size} {sorts} {all_workspaces}
_GetFor
Returns a git lab by an id for an user_id
ns-credential gitlab _getfor {user_id} {id}
Get
Returns a git lab by an id
ns-credential gitlab get {id}
Create
Creates a new git lab
ns-credential gitlab create
--host (String)
--type (Enum)
--username (String)
--password (String)
--pat_token (String)
--oauth_client_id (String)
--oauth_client_secret (String)
--oauth_refresh_token (String)
--oauth_access_token (String)
--ssh_publickey (String)
--ssh_privatekey (String)
--workspace_id (String)
--name (String)
--description (String)
--git_lab_category (Array)
--git_lab_field (Array)
--git_lab_tag (Array)
Update
Updates a git lab by an id
ns-credential gitlab update {id}
--host (String)
--username (String)
--password (String)
--pat_token (String)
--oauth_client_id (String)
--oauth_client_secret (String)
--oauth_refresh_token (String)
--oauth_access_token (String)
--ssh_publickey (String)
--ssh_privatekey (String)
--workspace_id (String)
--name (String)
--description (String)
--git_lab_category (Array)
--git_lab_field (Array)
--git_lab_tag (Array)
Delete
Deletes a git lab by an id
ns-credential gitlab delete {id}
TokenAuthCategory
List
Returns the token auth category list
ns-credential tokenauthcategory list {filters} {page} {size} {sorts} {all_workspaces}
Get
Returns a token auth category by id.
ns-credential tokenauthcategory get {id}
Create
Creates a new token auth category for an entity
ns-credential tokenauthcategory create
--category_id (String)
Delete
Deletes a token auth category by an id.
ns-credential tokenauthcategory delete {id}
TokenAuthField
List
Returns the token auth field list
ns-credential tokenauthfield list {filters} {page} {size} {sorts} {all_workspaces}
Get
Returns a token auth field by id.
ns-credential tokenauthfield get {id}
Create
Creates a new token auth field for an entity
ns-credential tokenauthfield create
--field_id (String)
--value (Any)
Update
Updates a token auth field by an id for an entity
ns-credential tokenauthfield update {id}
--field_id (String)
--value (Any)
Delete
Deletes a token auth field by an id.
ns-credential tokenauthfield delete {id}
TokenAuthTag
List
Returns the token auth tag list
ns-credential tokenauthtag list {filters} {page} {size} {sorts} {all_workspaces}
Get
Returns a token auth tag by id.
ns-credential tokenauthtag get {id}
Create
Creates a new token auth tag for an entity
ns-credential tokenauthtag create
--name (String)
--value (String)
Update
Updates a token auth tag by an id for an entity
ns-credential tokenauthtag update {id}
--name (String)
--value (String)
Delete
Deletes a token auth tag by an id.
ns-credential tokenauthtag delete {id}
TokenAuth
List
Returns the token auth list
ns-credential tokenauth list {filters} {page} {size} {sorts} {all_workspaces}
_GetFor
Returns a token auth by an id for an user_id
ns-credential tokenauth _getfor {user_id} {id}
Get
Returns a token auth by an id
ns-credential tokenauth get {id}
Create
Creates a new token auth
ns-credential tokenauth create
--token (String)
--workspace_id (String)
--name (String)
--description (String)
--token_auth_category (Array)
--token_auth_field (Array)
--token_auth_tag (Array)
Update
Updates a token auth by an id
ns-credential tokenauth update {id}
--token (String)
--workspace_id (String)
--name (String)
--description (String)
--token_auth_category (Array)
--token_auth_field (Array)
--token_auth_tag (Array)
Delete
Deletes a token auth by an id
ns-credential tokenauth delete {id}
HostTokenAuthCategory
List
Returns the host token auth category list
ns-credential hosttokenauthcategory list {filters} {page} {size} {sorts} {all_workspaces}
Get
Returns a host token auth category by id.
ns-credential hosttokenauthcategory get {id}
Create
Creates a new host token auth category for an entity
ns-credential hosttokenauthcategory create
--category_id (String)
Delete
Deletes a host token auth category by an id.
ns-credential hosttokenauthcategory delete {id}
HostTokenAuthField
List
Returns the host token auth field list
ns-credential hosttokenauthfield list {filters} {page} {size} {sorts} {all_workspaces}
Get
Returns a host token auth field by id.
ns-credential hosttokenauthfield get {id}
Create
Creates a new host token auth field for an entity
ns-credential hosttokenauthfield create
--field_id (String)
--value (Any)
Update
Updates a host token auth field by an id for an entity
ns-credential hosttokenauthfield update {id}
--field_id (String)
--value (Any)
Delete
Deletes a host token auth field by an id.
ns-credential hosttokenauthfield delete {id}
HostTokenAuthTag
List
Returns the host token auth tag list
ns-credential hosttokenauthtag list {filters} {page} {size} {sorts} {all_workspaces}
Get
Returns a host token auth tag by id.
ns-credential hosttokenauthtag get {id}
Create
Creates a new host token auth tag for an entity
ns-credential hosttokenauthtag create
--name (String)
--value (String)
Update
Updates a host token auth tag by an id for an entity
ns-credential hosttokenauthtag update {id}
--name (String)
--value (String)
Delete
Deletes a host token auth tag by an id.
ns-credential hosttokenauthtag delete {id}
HostTokenAuth
List
Returns the host token auth list
ns-credential hosttokenauth list {filters} {page} {size} {sorts} {all_workspaces}
_GetFor
Returns a host token auth by an id for an user_id
ns-credential hosttokenauth _getfor {user_id} {id}
Get
Returns a host token auth by an id
ns-credential hosttokenauth get {id}
Create
Creates a new host token auth
ns-credential hosttokenauth create
--host (String)
--token (String)
--workspace_id (String)
--name (String)
--description (String)
--host_token_auth_category (Array)
--host_token_auth_field (Array)
--host_token_auth_tag (Array)
Update
Updates a host token auth by an id
ns-credential hosttokenauth update {id}
--host (String)
--token (String)
--workspace_id (String)
--name (String)
--description (String)
--host_token_auth_category (Array)
--host_token_auth_field (Array)
--host_token_auth_tag (Array)
Delete
Deletes a host token auth by an id
ns-credential hosttokenauth delete {id}
BasicAuthCategory
List
Returns the basic auth category list
ns-credential basicauthcategory list {filters} {page} {size} {sorts} {all_workspaces}
Get
Returns a basic auth category by id.
ns-credential basicauthcategory get {id}
Create
Creates a new basic auth category for an entity
ns-credential basicauthcategory create
--category_id (String)
Delete
Deletes a basic auth category by an id.
ns-credential basicauthcategory delete {id}
BasicAuthField
List
Returns the basic auth field list
ns-credential basicauthfield list {filters} {page} {size} {sorts} {all_workspaces}
Get
Returns a basic auth field by id.
ns-credential basicauthfield get {id}
Create
Creates a new basic auth field for an entity
ns-credential basicauthfield create
--field_id (String)
--value (Any)
Update
Updates a basic auth field by an id for an entity
ns-credential basicauthfield update {id}
--field_id (String)
--value (Any)
Delete
Deletes a basic auth field by an id.
ns-credential basicauthfield delete {id}
BasicAuthTag
List
Returns the basic auth tag list
ns-credential basicauthtag list {filters} {page} {size} {sorts} {all_workspaces}
Get
Returns a basic auth tag by id.
ns-credential basicauthtag get {id}
Create
Creates a new basic auth tag for an entity
ns-credential basicauthtag create
--name (String)
--value (String)
Update
Updates a basic auth tag by an id for an entity
ns-credential basicauthtag update {id}
--name (String)
--value (String)
Delete
Deletes a basic auth tag by an id.
ns-credential basicauthtag delete {id}
BasicAuth
List
Returns the basic auth list
ns-credential basicauth list {filters} {page} {size} {sorts} {all_workspaces}
_GetFor
Returns a basic auth by an id for an user_id
ns-credential basicauth _getfor {user_id} {id}
Get
Returns a basic auth by an id
ns-credential basicauth get {id}
Create
Creates a new basic auth
ns-credential basicauth create
--username (String)
--password (String)
--workspace_id (String)
--name (String)
--description (String)
--basic_auth_category (Array)
--basic_auth_field (Array)
--basic_auth_tag (Array)
Update
Updates a basic auth by an id
ns-credential basicauth update {id}
--username (String)
--password (String)
--workspace_id (String)
--name (String)
--description (String)
--basic_auth_category (Array)
--basic_auth_field (Array)
--basic_auth_tag (Array)
Delete
Deletes a basic auth by an id
ns-credential basicauth delete {id}
HostBasicAuthCategory
List
Returns the host basic auth category list
ns-credential hostbasicauthcategory list {filters} {page} {size} {sorts} {all_workspaces}
Get
Returns a host basic auth category by id.
ns-credential hostbasicauthcategory get {id}
Create
Creates a new host basic auth category for an entity
ns-credential hostbasicauthcategory create
--category_id (String)
Delete
Deletes a host basic auth category by an id.
ns-credential hostbasicauthcategory delete {id}
HostBasicAuthField
List
Returns the host basic auth field list
ns-credential hostbasicauthfield list {filters} {page} {size} {sorts} {all_workspaces}
Get
Returns a host basic auth field by id.
ns-credential hostbasicauthfield get {id}
Create
Creates a new host basic auth field for an entity
ns-credential hostbasicauthfield create
--field_id (String)
--value (Any)
Update
Updates a host basic auth field by an id for an entity
ns-credential hostbasicauthfield update {id}
--field_id (String)
--value (Any)
Delete
Deletes a host basic auth field by an id.
ns-credential hostbasicauthfield delete {id}
HostBasicAuthTag
List
Returns the host basic auth tag list
ns-credential hostbasicauthtag list {filters} {page} {size} {sorts} {all_workspaces}
Get
Returns a host basic auth tag by id.
ns-credential hostbasicauthtag get {id}
Create
Creates a new host basic auth tag for an entity
ns-credential hostbasicauthtag create
--name (String)
--value (String)
Update
Updates a host basic auth tag by an id for an entity
ns-credential hostbasicauthtag update {id}
--name (String)
--value (String)
Delete
Deletes a host basic auth tag by an id.
ns-credential hostbasicauthtag delete {id}
HostBasicAuth
List
Returns the host basic auth list
ns-credential hostbasicauth list {filters} {page} {size} {sorts} {all_workspaces}
_GetFor
Returns a host basic auth by an id for an user_id
ns-credential hostbasicauth _getfor {user_id} {id}
Get
Returns a host basic auth by an id
ns-credential hostbasicauth get {id}
Create
Creates a new host basic auth
ns-credential hostbasicauth create
--host (String)
--username (String)
--password (String)
--workspace_id (String)
--name (String)
--description (String)
--host_basic_auth_category (Array)
--host_basic_auth_field (Array)
--host_basic_auth_tag (Array)
Update
Updates a host basic auth by an id
ns-credential hostbasicauth update {id}
--host (String)
--username (String)
--password (String)
--workspace_id (String)
--name (String)
--description (String)
--host_basic_auth_category (Array)
--host_basic_auth_field (Array)
--host_basic_auth_tag (Array)
Delete
Deletes a host basic auth by an id
ns-credential hostbasicauth delete {id}
SshCategory
List
Returns the ssh category list
ns-credential sshcategory list {filters} {page} {size} {sorts} {all_workspaces}
Get
Returns a ssh category by id.
ns-credential sshcategory get {id}
Create
Creates a new ssh category for an entity
ns-credential sshcategory create
--category_id (String)
Delete
Deletes a ssh category by an id.
ns-credential sshcategory delete {id}
SshField
List
Returns the ssh field list
ns-credential sshfield list {filters} {page} {size} {sorts} {all_workspaces}
Get
Returns a ssh field by id.
ns-credential sshfield get {id}
Create
Creates a new ssh field for an entity
ns-credential sshfield create
--field_id (String)
--value (Any)
Update
Updates a ssh field by an id for an entity
ns-credential sshfield update {id}
--field_id (String)
--value (Any)
Delete
Deletes a ssh field by an id.
ns-credential sshfield delete {id}
SshTag
List
Returns the ssh tag list
ns-credential sshtag list {filters} {page} {size} {sorts} {all_workspaces}
Get
Returns a ssh tag by id.
ns-credential sshtag get {id}
Create
Creates a new ssh tag for an entity
ns-credential sshtag create
--name (String)
--value (String)
Update
Updates a ssh tag by an id for an entity
ns-credential sshtag update {id}
--name (String)
--value (String)
Delete
Deletes a ssh tag by an id.
ns-credential sshtag delete {id}
SSH
List
Returns the ssh list
ns-credential ssh list {filters} {page} {size} {sorts} {all_workspaces}
_GetFor
Returns a SSH credential by an id for an user_id
ns-credential ssh _getfor {user_id} {id}
Get
Returns a ssh by an id
ns-credential ssh get {id}
Create
Creates a new ssh
ns-credential ssh create
--host (String)
--port (Integer)
--auth_type (Enum)
--username (String)
--password (String)
--private_key (String)
--private_key_passphrase (String)
--fingerprint (String)
--workspace_id (String)
--name (String)
--description (String)
--ssh_category (Array)
--ssh_field (Array)
--ssh_tag (Array)
Update
Updates a ssh by an id
ns-credential ssh update {id}
--host (String)
--port (Integer)
--username (String)
--password (String)
--private_key (String)
--private_key_passphrase (String)
--fingerprint (String)
--workspace_id (String)
--name (String)
--description (String)
--ssh_category (Array)
--ssh_field (Array)
--ssh_tag (Array)
Delete
Deletes a ssh by an id
ns-credential ssh delete {id}
Schemas
Credential
{ "name": "Credential", "type": "Object", "required": true, "fields": { "id": { "type": "String", "required": true, "min": 20, "max": 20 }, "group_id": { "type": "String", "required": true, "min": 20, "max": 20 }, "entity_id": { "type": "String", "required": true, "min": 20, "max": 20 }, "user_id": { "type": "String", "required": true, "min": 20, "max": 20 }, "workspace_id": { "type": "String", "required": true, "min": 20, "max": 20 }, "group_type": { "name": "CredentialGroupType", "type": "Enum", "required": true, "valids": [ "Protocol", "Cloud", "Database", "SourceControl" ] }, "entity_type": { "name": "CredentialEntityType", "type": "Enum", "required": true, "valids": [ "AWS", "Azure", "BasicAuth", "HostBasicAuth", "Credential", "Database", "GCP", "GitHub", "GitLab", "SSH", "TokenAuth", "HostTokenAuth" ] }, "name": { "type": "String", "required": true, "max": 255 }, "description": { "type": "String", "required": false }, "created_at": { "type": "DateTime", "required": true }, "updated_at": { "type": "DateTime", "required": true } }}
Protocol
{ "name": "Protocol", "type": "Object", "required": true, "fields": { "id": { "type": "String", "required": true, "min": 20, "max": 20 }, "credential_id": { "type": "String", "required": true, "min": 20, "max": 20 }, "entity_id": { "type": "String", "required": true, "min": 20, "max": 20 }, "created_at": { "type": "DateTime", "required": true }, "updated_at": { "type": "DateTime", "required": true }, "group_id": { "type": "String", "required": true, "min": 20, "max": 20 }, "user_id": { "type": "String", "required": true, "min": 20, "max": 20 }, "workspace_id": { "type": "String", "required": true, "min": 20, "max": 20 }, "group_type": { "name": "CredentialGroupType", "type": "Enum", "required": true, "valids": [ "Protocol", "Cloud", "Database", "SourceControl" ] }, "entity_type": { "name": "CredentialEntityType", "type": "Enum", "required": true, "valids": [ "AWS", "Azure", "BasicAuth", "HostBasicAuth", "Credential", "Database", "GCP", "GitHub", "GitLab", "SSH", "TokenAuth", "HostTokenAuth" ] }, "name": { "type": "String", "required": true, "max": 255 }, "description": { "type": "String", "required": false } }}
Cloud
{ "name": "Cloud", "type": "Object", "required": true, "fields": { "id": { "type": "String", "required": true, "min": 20, "max": 20 }, "credential_id": { "type": "String", "required": true, "min": 20, "max": 20 }, "entity_id": { "type": "String", "required": true, "min": 20, "max": 20 }, "created_at": { "type": "DateTime", "required": true }, "updated_at": { "type": "DateTime", "required": true }, "group_id": { "type": "String", "required": true, "min": 20, "max": 20 }, "user_id": { "type": "String", "required": true, "min": 20, "max": 20 }, "workspace_id": { "type": "String", "required": true, "min": 20, "max": 20 }, "group_type": { "name": "CredentialGroupType", "type": "Enum", "required": true, "valids": [ "Protocol", "Cloud", "Database", "SourceControl" ] }, "entity_type": { "name": "CredentialEntityType", "type": "Enum", "required": true, "valids": [ "AWS", "Azure", "BasicAuth", "HostBasicAuth", "Credential", "Database", "GCP", "GitHub", "GitLab", "SSH", "TokenAuth", "HostTokenAuth" ] }, "name": { "type": "String", "required": true, "max": 255 }, "description": { "type": "String", "required": false } }}
SourceControl
{ "name": "SourceControl", "type": "Object", "required": true, "fields": { "id": { "type": "String", "required": true, "min": 20, "max": 20 }, "credential_id": { "type": "String", "required": true, "min": 20, "max": 20 }, "entity_id": { "type": "String", "required": true, "min": 20, "max": 20 }, "created_at": { "type": "DateTime", "required": true }, "updated_at": { "type": "DateTime", "required": true }, "group_id": { "type": "String", "required": true, "min": 20, "max": 20 }, "user_id": { "type": "String", "required": true, "min": 20, "max": 20 }, "workspace_id": { "type": "String", "required": true, "min": 20, "max": 20 }, "group_type": { "name": "CredentialGroupType", "type": "Enum", "required": true, "valids": [ "Protocol", "Cloud", "Database", "SourceControl" ] }, "entity_type": { "name": "CredentialEntityType", "type": "Enum", "required": true, "valids": [ "AWS", "Azure", "BasicAuth", "HostBasicAuth", "Credential", "Database", "GCP", "GitHub", "GitLab", "SSH", "TokenAuth", "HostTokenAuth" ] }, "name": { "type": "String", "required": true, "max": 255 }, "description": { "type": "String", "required": false } }}
AWSCategory
{ "name": "AWSCategory", "type": "Object", "required": true, "fields": { "id": { "type": "Integer", "required": true }, "user_id": { "type": "String", "required": true, "min": 20, "max": 20 }, "entity_id": { "type": "String", "required": true, "min": 20, "max": 20 }, "category_id": { "type": "String", "required": true, "min": 20, "max": 20 }, "created_at": { "type": "DateTime", "required": true }, "updated_at": { "type": "DateTime", "required": true } }}
EntityCategoryInput
{ "name": "EntityCategoryInput", "type": "Object", "required": true, "fields": { "category_id": { "type": "String", "required": true, "min": 20, "max": 20 } }}
AWSField
{ "name": "AWSField", "type": "Object", "required": true, "fields": { "id": { "type": "Integer", "required": true }, "user_id": { "type": "String", "required": true, "min": 20, "max": 20 }, "entity_id": { "type": "String", "required": true, "min": 20, "max": 20 }, "field_id": { "type": "String", "required": true, "min": 20, "max": 20 }, "value": { "type": "String", "required": false }, "created_at": { "type": "DateTime", "required": true }, "updated_at": { "type": "DateTime", "required": true } }}
EntityFieldInput
{ "name": "EntityFieldInput", "type": "Object", "required": true, "fields": { "field_id": { "type": "String", "required": true, "min": 20, "max": 20 }, "value": { "type": "Any", "required": false } }}
AWSTag
{ "name": "AWSTag", "type": "Object", "required": true, "fields": { "id": { "type": "Integer", "required": true }, "user_id": { "type": "String", "required": true, "min": 20, "max": 20 }, "entity_id": { "type": "String", "required": true, "min": 20, "max": 20 }, "name": { "type": "String", "required": true, "max": 255 }, "value": { "type": "String", "required": false }, "created_at": { "type": "DateTime", "required": true }, "updated_at": { "type": "DateTime", "required": true } }}
EntityTagInput
{ "name": "EntityTagInput", "type": "Object", "required": true, "fields": { "name": { "type": "String", "required": true, "max": 255 }, "value": { "type": "String", "required": false } }}
AWS
{ "name": "AWS", "type": "Object", "required": true, "fields": { "id": { "type": "String", "required": true, "min": 20, "max": 20 }, "credential_id": { "type": "String", "required": true, "min": 20, "max": 20 }, "cloud_id": { "type": "String", "required": true, "min": 20, "max": 20 }, "access_key_secret_id": { "type": "String", "required": true, "min": 20, "max": 20 }, "secret_key_secret_id": { "type": "String", "required": true, "min": 20, "max": 20 }, "created_at": { "type": "DateTime", "required": true }, "updated_at": { "type": "DateTime", "required": true }, "entity_id": { "type": "String", "required": true, "min": 20, "max": 20 }, "group_id": { "type": "String", "required": true, "min": 20, "max": 20 }, "user_id": { "type": "String", "required": true, "min": 20, "max": 20 }, "workspace_id": { "type": "String", "required": true, "min": 20, "max": 20 }, "group_type": { "name": "CredentialGroupType", "type": "Enum", "required": true, "valids": [ "Protocol", "Cloud", "Database", "SourceControl" ] }, "entity_type": { "name": "CredentialEntityType", "type": "Enum", "required": true, "valids": [ "AWS", "Azure", "BasicAuth", "HostBasicAuth", "Credential", "Database", "GCP", "GitHub", "GitLab", "SSH", "TokenAuth", "HostTokenAuth" ] }, "name": { "type": "String", "required": true, "max": 255 }, "description": { "type": "String", "required": false } }}
AWSCreate
{ "name": "AWSCreate", "type": "Object", "required": true, "fields": { "access_key": { "type": "String", "required": true }, "secret_key": { "type": "String", "required": true }, "workspace_id": { "type": "String", "required": false, "min": 20, "max": 20 }, "name": { "type": "String", "required": true, "max": 255 }, "description": { "type": "String", "required": false }, "aws_category": { "type": "Array", "required": true, "items": [ { "name": "EntityCategoryInput", "type": "Object", "required": false, "fields": { "category_id": { "type": "String", "required": true, "min": 20, "max": 20 } } } ] }, "aws_field": { "type": "Array", "required": true, "items": [ { "name": "EntityFieldInput", "type": "Object", "required": false, "fields": { "field_id": { "type": "String", "required": true, "min": 20, "max": 20 }, "value": { "type": "Any", "required": false } } } ] }, "aws_tag": { "type": "Array", "required": true, "items": [ { "name": "EntityTagInput", "type": "Object", "required": false, "fields": { "name": { "type": "String", "required": true, "max": 255 }, "value": { "type": "String", "required": false } } } ] } }}
AWSUpdate
{ "name": "AWSUpdate", "type": "Object", "required": true, "fields": { "access_key": { "type": "String", "required": false }, "secret_key": { "type": "String", "required": false }, "workspace_id": { "type": "String", "required": false, "min": 20, "max": 20 }, "name": { "type": "String", "required": true, "max": 255 }, "description": { "type": "String", "required": false }, "aws_category": { "type": "Array", "required": true, "items": [ { "name": "EntityCategoryInput", "type": "Object", "required": false, "fields": { "category_id": { "type": "String", "required": true, "min": 20, "max": 20 } } } ] }, "aws_field": { "type": "Array", "required": true, "items": [ { "name": "EntityFieldInput", "type": "Object", "required": false, "fields": { "field_id": { "type": "String", "required": true, "min": 20, "max": 20 }, "value": { "type": "Any", "required": false } } } ] }, "aws_tag": { "type": "Array", "required": true, "items": [ { "name": "EntityTagInput", "type": "Object", "required": false, "fields": { "name": { "type": "String", "required": true, "max": 255 }, "value": { "type": "String", "required": false } } } ] } }}
AzureCategory
{ "name": "AzureCategory", "type": "Object", "required": true, "fields": { "id": { "type": "Integer", "required": true }, "user_id": { "type": "String", "required": true, "min": 20, "max": 20 }, "entity_id": { "type": "String", "required": true, "min": 20, "max": 20 }, "category_id": { "type": "String", "required": true, "min": 20, "max": 20 }, "created_at": { "type": "DateTime", "required": true }, "updated_at": { "type": "DateTime", "required": true } }}
AzureField
{ "name": "AzureField", "type": "Object", "required": true, "fields": { "id": { "type": "Integer", "required": true }, "user_id": { "type": "String", "required": true, "min": 20, "max": 20 }, "entity_id": { "type": "String", "required": true, "min": 20, "max": 20 }, "field_id": { "type": "String", "required": true, "min": 20, "max": 20 }, "value": { "type": "String", "required": false }, "created_at": { "type": "DateTime", "required": true }, "updated_at": { "type": "DateTime", "required": true } }}
AzureTag
{ "name": "AzureTag", "type": "Object", "required": true, "fields": { "id": { "type": "Integer", "required": true }, "user_id": { "type": "String", "required": true, "min": 20, "max": 20 }, "entity_id": { "type": "String", "required": true, "min": 20, "max": 20 }, "name": { "type": "String", "required": true, "max": 255 }, "value": { "type": "String", "required": false }, "created_at": { "type": "DateTime", "required": true }, "updated_at": { "type": "DateTime", "required": true } }}
Azure
{ "name": "Azure", "type": "Object", "required": true, "fields": { "id": { "type": "String", "required": true, "min": 20, "max": 20 }, "credential_id": { "type": "String", "required": true, "min": 20, "max": 20 }, "cloud_id": { "type": "String", "required": true, "min": 20, "max": 20 }, "tenant_id_secret_id": { "type": "String", "required": true, "min": 20, "max": 20 }, "client_id_secret_id": { "type": "String", "required": true, "min": 20, "max": 20 }, "client_secret_secret_id": { "type": "String", "required": true, "min": 20, "max": 20 }, "created_at": { "type": "DateTime", "required": true }, "updated_at": { "type": "DateTime", "required": true }, "entity_id": { "type": "String", "required": true, "min": 20, "max": 20 }, "group_id": { "type": "String", "required": true, "min": 20, "max": 20 }, "user_id": { "type": "String", "required": true, "min": 20, "max": 20 }, "workspace_id": { "type": "String", "required": true, "min": 20, "max": 20 }, "group_type": { "name": "CredentialGroupType", "type": "Enum", "required": true, "valids": [ "Protocol", "Cloud", "Database", "SourceControl" ] }, "entity_type": { "name": "CredentialEntityType", "type": "Enum", "required": true, "valids": [ "AWS", "Azure", "BasicAuth", "HostBasicAuth", "Credential", "Database", "GCP", "GitHub", "GitLab", "SSH", "TokenAuth", "HostTokenAuth" ] }, "name": { "type": "String", "required": true, "max": 255 }, "description": { "type": "String", "required": false } }}
AzureCreate
{ "name": "AzureCreate", "type": "Object", "required": true, "fields": { "tenant_id": { "type": "String", "required": true }, "client_id": { "type": "String", "required": true }, "client_secret": { "type": "String", "required": true }, "workspace_id": { "type": "String", "required": false, "min": 20, "max": 20 }, "name": { "type": "String", "required": true, "max": 255 }, "description": { "type": "String", "required": false }, "azure_category": { "type": "Array", "required": true, "items": [ { "name": "EntityCategoryInput", "type": "Object", "required": false, "fields": { "category_id": { "type": "String", "required": true, "min": 20, "max": 20 } } } ] }, "azure_field": { "type": "Array", "required": true, "items": [ { "name": "EntityFieldInput", "type": "Object", "required": false, "fields": { "field_id": { "type": "String", "required": true, "min": 20, "max": 20 }, "value": { "type": "Any", "required": false } } } ] }, "azure_tag": { "type": "Array", "required": true, "items": [ { "name": "EntityTagInput", "type": "Object", "required": false, "fields": { "name": { "type": "String", "required": true, "max": 255 }, "value": { "type": "String", "required": false } } } ] } }}
AzureUpdate
{ "name": "AzureUpdate", "type": "Object", "required": true, "fields": { "tenant_id": { "type": "String", "required": false }, "client_id": { "type": "String", "required": false }, "client_secret": { "type": "String", "required": false }, "workspace_id": { "type": "String", "required": false, "min": 20, "max": 20 }, "name": { "type": "String", "required": true, "max": 255 }, "description": { "type": "String", "required": false }, "azure_category": { "type": "Array", "required": true, "items": [ { "name": "EntityCategoryInput", "type": "Object", "required": false, "fields": { "category_id": { "type": "String", "required": true, "min": 20, "max": 20 } } } ] }, "azure_field": { "type": "Array", "required": true, "items": [ { "name": "EntityFieldInput", "type": "Object", "required": false, "fields": { "field_id": { "type": "String", "required": true, "min": 20, "max": 20 }, "value": { "type": "Any", "required": false } } } ] }, "azure_tag": { "type": "Array", "required": true, "items": [ { "name": "EntityTagInput", "type": "Object", "required": false, "fields": { "name": { "type": "String", "required": true, "max": 255 }, "value": { "type": "String", "required": false } } } ] } }}
GCPCategory
{ "name": "GCPCategory", "type": "Object", "required": true, "fields": { "id": { "type": "Integer", "required": true }, "user_id": { "type": "String", "required": true, "min": 20, "max": 20 }, "entity_id": { "type": "String", "required": true, "min": 20, "max": 20 }, "category_id": { "type": "String", "required": true, "min": 20, "max": 20 }, "created_at": { "type": "DateTime", "required": true }, "updated_at": { "type": "DateTime", "required": true } }}
GCPField
{ "name": "GCPField", "type": "Object", "required": true, "fields": { "id": { "type": "Integer", "required": true }, "user_id": { "type": "String", "required": true, "min": 20, "max": 20 }, "entity_id": { "type": "String", "required": true, "min": 20, "max": 20 }, "field_id": { "type": "String", "required": true, "min": 20, "max": 20 }, "value": { "type": "String", "required": false }, "created_at": { "type": "DateTime", "required": true }, "updated_at": { "type": "DateTime", "required": true } }}
GCPTag
{ "name": "GCPTag", "type": "Object", "required": true, "fields": { "id": { "type": "Integer", "required": true }, "user_id": { "type": "String", "required": true, "min": 20, "max": 20 }, "entity_id": { "type": "String", "required": true, "min": 20, "max": 20 }, "name": { "type": "String", "required": true, "max": 255 }, "value": { "type": "String", "required": false }, "created_at": { "type": "DateTime", "required": true }, "updated_at": { "type": "DateTime", "required": true } }}
GCP
{ "name": "GCP", "type": "Object", "required": true, "fields": { "id": { "type": "String", "required": true, "min": 20, "max": 20 }, "credential_id": { "type": "String", "required": true, "min": 20, "max": 20 }, "cloud_id": { "type": "String", "required": true, "min": 20, "max": 20 }, "credentials_secret_id": { "type": "String", "required": true, "min": 20, "max": 20 }, "created_at": { "type": "DateTime", "required": true }, "updated_at": { "type": "DateTime", "required": true }, "entity_id": { "type": "String", "required": true, "min": 20, "max": 20 }, "group_id": { "type": "String", "required": true, "min": 20, "max": 20 }, "user_id": { "type": "String", "required": true, "min": 20, "max": 20 }, "workspace_id": { "type": "String", "required": true, "min": 20, "max": 20 }, "group_type": { "name": "CredentialGroupType", "type": "Enum", "required": true, "valids": [ "Protocol", "Cloud", "Database", "SourceControl" ] }, "entity_type": { "name": "CredentialEntityType", "type": "Enum", "required": true, "valids": [ "AWS", "Azure", "BasicAuth", "HostBasicAuth", "Credential", "Database", "GCP", "GitHub", "GitLab", "SSH", "TokenAuth", "HostTokenAuth" ] }, "name": { "type": "String", "required": true, "max": 255 }, "description": { "type": "String", "required": false } }}
GCPCreate
{ "name": "GCPCreate", "type": "Object", "required": true, "fields": { "credentials": { "type": "String", "required": true }, "workspace_id": { "type": "String", "required": false, "min": 20, "max": 20 }, "name": { "type": "String", "required": true, "max": 255 }, "description": { "type": "String", "required": false }, "gcp_category": { "type": "Array", "required": true, "items": [ { "name": "EntityCategoryInput", "type": "Object", "required": false, "fields": { "category_id": { "type": "String", "required": true, "min": 20, "max": 20 } } } ] }, "gcp_field": { "type": "Array", "required": true, "items": [ { "name": "EntityFieldInput", "type": "Object", "required": false, "fields": { "field_id": { "type": "String", "required": true, "min": 20, "max": 20 }, "value": { "type": "Any", "required": false } } } ] }, "gcp_tag": { "type": "Array", "required": true, "items": [ { "name": "EntityTagInput", "type": "Object", "required": false, "fields": { "name": { "type": "String", "required": true, "max": 255 }, "value": { "type": "String", "required": false } } } ] } }}
GCPUpdate
{ "name": "GCPUpdate", "type": "Object", "required": true, "fields": { "credentials": { "type": "String", "required": false }, "workspace_id": { "type": "String", "required": false, "min": 20, "max": 20 }, "name": { "type": "String", "required": true, "max": 255 }, "description": { "type": "String", "required": false }, "gcp_category": { "type": "Array", "required": true, "items": [ { "name": "EntityCategoryInput", "type": "Object", "required": false, "fields": { "category_id": { "type": "String", "required": true, "min": 20, "max": 20 } } } ] }, "gcp_field": { "type": "Array", "required": true, "items": [ { "name": "EntityFieldInput", "type": "Object", "required": false, "fields": { "field_id": { "type": "String", "required": true, "min": 20, "max": 20 }, "value": { "type": "Any", "required": false } } } ] }, "gcp_tag": { "type": "Array", "required": true, "items": [ { "name": "EntityTagInput", "type": "Object", "required": false, "fields": { "name": { "type": "String", "required": true, "max": 255 }, "value": { "type": "String", "required": false } } } ] } }}
GitHubCategory
{ "name": "GitHubCategory", "type": "Object", "required": true, "fields": { "id": { "type": "Integer", "required": true }, "user_id": { "type": "String", "required": true, "min": 20, "max": 20 }, "entity_id": { "type": "String", "required": true, "min": 20, "max": 20 }, "category_id": { "type": "String", "required": true, "min": 20, "max": 20 }, "created_at": { "type": "DateTime", "required": true }, "updated_at": { "type": "DateTime", "required": true } }}
GitHubField
{ "name": "GitHubField", "type": "Object", "required": true, "fields": { "id": { "type": "Integer", "required": true }, "user_id": { "type": "String", "required": true, "min": 20, "max": 20 }, "entity_id": { "type": "String", "required": true, "min": 20, "max": 20 }, "field_id": { "type": "String", "required": true, "min": 20, "max": 20 }, "value": { "type": "String", "required": false }, "created_at": { "type": "DateTime", "required": true }, "updated_at": { "type": "DateTime", "required": true } }}
GitHubTag
{ "name": "GitHubTag", "type": "Object", "required": true, "fields": { "id": { "type": "Integer", "required": true }, "user_id": { "type": "String", "required": true, "min": 20, "max": 20 }, "entity_id": { "type": "String", "required": true, "min": 20, "max": 20 }, "name": { "type": "String", "required": true, "max": 255 }, "value": { "type": "String", "required": false }, "created_at": { "type": "DateTime", "required": true }, "updated_at": { "type": "DateTime", "required": true } }}
GitHub
{ "name": "GitHub", "type": "Object", "required": true, "fields": { "id": { "type": "String", "required": true, "min": 20, "max": 20 }, "credential_id": { "type": "String", "required": true, "min": 20, "max": 20 }, "source_control_id": { "type": "String", "required": true, "min": 20, "max": 20 }, "host": { "type": "String", "required": true, "max": 255 }, "type": { "name": "GitHubType", "type": "Enum", "required": true, "valids": [ "Password", "PATClassic", "PATFineGrained", "OAuthApp", "GitHubApp", "SSH" ] }, "username_secret_id": { "type": "String", "required": true, "min": 20, "max": 20 }, "password_secret_id": { "type": "String", "required": false, "min": 20, "max": 20 }, "pat_classic_token_secret_id": { "type": "String", "required": false, "min": 20, "max": 20 }, "pat_finegraned_token_secret_id": { "type": "String", "required": false, "min": 20, "max": 20 }, "oauthapp_client_id_secret_id": { "type": "String", "required": false, "min": 20, "max": 20 }, "oauthapp_client_secret_secret_id": { "type": "String", "required": false, "min": 20, "max": 20 }, "oauthapp_refresh_token_secret_id": { "type": "String", "required": false, "min": 20, "max": 20 }, "oauthapp_access_token_secret_id": { "type": "String", "required": false, "min": 20, "max": 20 }, "githubapp_installation_id_secret_id": { "type": "String", "required": false, "min": 20, "max": 20 }, "githubapp_jwt_secret_id": { "type": "String", "required": false, "min": 20, "max": 20 }, "githubapp_token_secret_id": { "type": "String", "required": false, "min": 20, "max": 20 }, "ssh_publickey_secret_id": { "type": "String", "required": false, "min": 20, "max": 20 }, "ssh_privatekey_secret_id": { "type": "String", "required": false, "min": 20, "max": 20 }, "created_at": { "type": "DateTime", "required": true }, "updated_at": { "type": "DateTime", "required": true }, "entity_id": { "type": "String", "required": true, "min": 20, "max": 20 }, "group_id": { "type": "String", "required": true, "min": 20, "max": 20 }, "user_id": { "type": "String", "required": true, "min": 20, "max": 20 }, "workspace_id": { "type": "String", "required": true, "min": 20, "max": 20 }, "group_type": { "name": "CredentialGroupType", "type": "Enum", "required": true, "valids": [ "Protocol", "Cloud", "Database", "SourceControl" ] }, "entity_type": { "name": "CredentialEntityType", "type": "Enum", "required": true, "valids": [ "AWS", "Azure", "BasicAuth", "HostBasicAuth", "Credential", "Database", "GCP", "GitHub", "GitLab", "SSH", "TokenAuth", "HostTokenAuth" ] }, "name": { "type": "String", "required": true, "max": 255 }, "description": { "type": "String", "required": false } }}
GitHubCreate
{ "name": "GitHubCreate", "type": "Object", "required": true, "fields": { "host": { "type": "String", "required": true, "max": 255 }, "type": { "name": "GitHubType", "type": "Enum", "required": true, "valids": [ "Password", "PATClassic", "PATFineGrained", "OAuthApp", "GitHubApp", "SSH" ] }, "username": { "type": "String", "required": true }, "password": { "type": "String", "required": false }, "pat_classic_token": { "type": "String", "required": false }, "pat_fine_graned_token": { "type": "String", "required": false }, "oauthapp_client_id": { "type": "String", "required": false }, "oauthapp_client_secret": { "type": "String", "required": false }, "oauthapp_refresh_token": { "type": "String", "required": false }, "oauthapp_access_token": { "type": "String", "required": false }, "githubapp_installation_id": { "type": "String", "required": false }, "githubapp_jwt": { "type": "String", "required": false }, "githubapp_token": { "type": "String", "required": false }, "ssh_publickey": { "type": "String", "required": false }, "ssh_privatekey": { "type": "String", "required": false }, "workspace_id": { "type": "String", "required": false, "min": 20, "max": 20 }, "name": { "type": "String", "required": true, "max": 255 }, "description": { "type": "String", "required": false }, "git_hub_category": { "type": "Array", "required": true, "items": [ { "name": "EntityCategoryInput", "type": "Object", "required": false, "fields": { "category_id": { "type": "String", "required": true, "min": 20, "max": 20 } } } ] }, "git_hub_field": { "type": "Array", "required": true, "items": [ { "name": "EntityFieldInput", "type": "Object", "required": false, "fields": { "field_id": { "type": "String", "required": true, "min": 20, "max": 20 }, "value": { "type": "Any", "required": false } } } ] }, "git_hub_tag": { "type": "Array", "required": true, "items": [ { "name": "EntityTagInput", "type": "Object", "required": false, "fields": { "name": { "type": "String", "required": true, "max": 255 }, "value": { "type": "String", "required": false } } } ] } }}
GitHubUpdate
{ "name": "GitHubUpdate", "type": "Object", "required": true, "fields": { "host": { "type": "String", "required": true, "max": 255 }, "username": { "type": "String", "required": true }, "password": { "type": "String", "required": false }, "pat_classic_token": { "type": "String", "required": false }, "pat_fine_graned_token": { "type": "String", "required": false }, "oauthapp_client_id": { "type": "String", "required": false }, "oauthapp_client_secret": { "type": "String", "required": false }, "oauthapp_refresh_token": { "type": "String", "required": false }, "oauthapp_access_token": { "type": "String", "required": false }, "githubapp_installation_id": { "type": "String", "required": false }, "githubapp_jwt": { "type": "String", "required": false }, "githubapp_token": { "type": "String", "required": false }, "ssh_publickey": { "type": "String", "required": false }, "ssh_privatekey": { "type": "String", "required": false }, "workspace_id": { "type": "String", "required": false, "min": 20, "max": 20 }, "name": { "type": "String", "required": true, "max": 255 }, "description": { "type": "String", "required": false }, "git_hub_category": { "type": "Array", "required": true, "items": [ { "name": "EntityCategoryInput", "type": "Object", "required": false, "fields": { "category_id": { "type": "String", "required": true, "min": 20, "max": 20 } } } ] }, "git_hub_field": { "type": "Array", "required": true, "items": [ { "name": "EntityFieldInput", "type": "Object", "required": false, "fields": { "field_id": { "type": "String", "required": true, "min": 20, "max": 20 }, "value": { "type": "Any", "required": false } } } ] }, "git_hub_tag": { "type": "Array", "required": true, "items": [ { "name": "EntityTagInput", "type": "Object", "required": false, "fields": { "name": { "type": "String", "required": true, "max": 255 }, "value": { "type": "String", "required": false } } } ] } }}
GitLabCategory
{ "name": "GitLabCategory", "type": "Object", "required": true, "fields": { "id": { "type": "Integer", "required": true }, "user_id": { "type": "String", "required": true, "min": 20, "max": 20 }, "entity_id": { "type": "String", "required": true, "min": 20, "max": 20 }, "category_id": { "type": "String", "required": true, "min": 20, "max": 20 }, "created_at": { "type": "DateTime", "required": true }, "updated_at": { "type": "DateTime", "required": true } }}
GitLabField
{ "name": "GitLabField", "type": "Object", "required": true, "fields": { "id": { "type": "Integer", "required": true }, "user_id": { "type": "String", "required": true, "min": 20, "max": 20 }, "entity_id": { "type": "String", "required": true, "min": 20, "max": 20 }, "field_id": { "type": "String", "required": true, "min": 20, "max": 20 }, "value": { "type": "String", "required": false }, "created_at": { "type": "DateTime", "required": true }, "updated_at": { "type": "DateTime", "required": true } }}
GitLabTag
{ "name": "GitLabTag", "type": "Object", "required": true, "fields": { "id": { "type": "Integer", "required": true }, "user_id": { "type": "String", "required": true, "min": 20, "max": 20 }, "entity_id": { "type": "String", "required": true, "min": 20, "max": 20 }, "name": { "type": "String", "required": true, "max": 255 }, "value": { "type": "String", "required": false }, "created_at": { "type": "DateTime", "required": true }, "updated_at": { "type": "DateTime", "required": true } }}
GitLab
{ "name": "GitLab", "type": "Object", "required": true, "fields": { "id": { "type": "String", "required": true, "min": 20, "max": 20 }, "credential_id": { "type": "String", "required": true, "min": 20, "max": 20 }, "source_control_id": { "type": "String", "required": true, "min": 20, "max": 20 }, "host": { "type": "String", "required": true, "max": 255 }, "type": { "name": "GitLabType", "type": "Enum", "required": true, "valids": [ "Password", "PAT", "OAuth", "SSH" ] }, "username_secret_id": { "type": "String", "required": true, "min": 20, "max": 20 }, "password_secret_id": { "type": "String", "required": false, "min": 20, "max": 20 }, "pat_token_secret_id": { "type": "String", "required": false, "min": 20, "max": 20 }, "oauth_client_id_secret_id": { "type": "String", "required": false, "min": 20, "max": 20 }, "oauth_client_secret_secret_id": { "type": "String", "required": false, "min": 20, "max": 20 }, "oauth_refresh_token_secret_id": { "type": "String", "required": false, "min": 20, "max": 20 }, "oauth_access_token_secret_id": { "type": "String", "required": false, "min": 20, "max": 20 }, "ssh_publickey_secret_id": { "type": "String", "required": false, "min": 20, "max": 20 }, "ssh_privatekey_secret_id": { "type": "String", "required": false, "min": 20, "max": 20 }, "created_at": { "type": "DateTime", "required": true }, "updated_at": { "type": "DateTime", "required": true }, "entity_id": { "type": "String", "required": true, "min": 20, "max": 20 }, "group_id": { "type": "String", "required": true, "min": 20, "max": 20 }, "user_id": { "type": "String", "required": true, "min": 20, "max": 20 }, "workspace_id": { "type": "String", "required": true, "min": 20, "max": 20 }, "group_type": { "name": "CredentialGroupType", "type": "Enum", "required": true, "valids": [ "Protocol", "Cloud", "Database", "SourceControl" ] }, "entity_type": { "name": "CredentialEntityType", "type": "Enum", "required": true, "valids": [ "AWS", "Azure", "BasicAuth", "HostBasicAuth", "Credential", "Database", "GCP", "GitHub", "GitLab", "SSH", "TokenAuth", "HostTokenAuth" ] }, "name": { "type": "String", "required": true, "max": 255 }, "description": { "type": "String", "required": false } }}
GitLabCreate
{ "name": "GitLabCreate", "type": "Object", "required": true, "fields": { "host": { "type": "String", "required": true, "max": 255 }, "type": { "name": "GitLabType", "type": "Enum", "required": true, "valids": [ "Password", "PAT", "OAuth", "SSH" ] }, "username": { "type": "String", "required": true }, "password": { "type": "String", "required": false }, "pat_token": { "type": "String", "required": false }, "oauth_client_id": { "type": "String", "required": false }, "oauth_client_secret": { "type": "String", "required": false }, "oauth_refresh_token": { "type": "String", "required": false }, "oauth_access_token": { "type": "String", "required": false }, "ssh_publickey": { "type": "String", "required": false }, "ssh_privatekey": { "type": "String", "required": false }, "workspace_id": { "type": "String", "required": false, "min": 20, "max": 20 }, "name": { "type": "String", "required": true, "max": 255 }, "description": { "type": "String", "required": false }, "git_lab_category": { "type": "Array", "required": true, "items": [ { "name": "EntityCategoryInput", "type": "Object", "required": false, "fields": { "category_id": { "type": "String", "required": true, "min": 20, "max": 20 } } } ] }, "git_lab_field": { "type": "Array", "required": true, "items": [ { "name": "EntityFieldInput", "type": "Object", "required": false, "fields": { "field_id": { "type": "String", "required": true, "min": 20, "max": 20 }, "value": { "type": "Any", "required": false } } } ] }, "git_lab_tag": { "type": "Array", "required": true, "items": [ { "name": "EntityTagInput", "type": "Object", "required": false, "fields": { "name": { "type": "String", "required": true, "max": 255 }, "value": { "type": "String", "required": false } } } ] } }}
GitLabUpdate
{ "name": "GitLabUpdate", "type": "Object", "required": true, "fields": { "host": { "type": "String", "required": true, "max": 255 }, "username": { "type": "String", "required": true }, "password": { "type": "String", "required": false }, "pat_token": { "type": "String", "required": false }, "oauth_client_id": { "type": "String", "required": false }, "oauth_client_secret": { "type": "String", "required": false }, "oauth_refresh_token": { "type": "String", "required": false }, "oauth_access_token": { "type": "String", "required": false }, "ssh_publickey": { "type": "String", "required": false }, "ssh_privatekey": { "type": "String", "required": false }, "workspace_id": { "type": "String", "required": false, "min": 20, "max": 20 }, "name": { "type": "String", "required": true, "max": 255 }, "description": { "type": "String", "required": false }, "git_lab_category": { "type": "Array", "required": true, "items": [ { "name": "EntityCategoryInput", "type": "Object", "required": false, "fields": { "category_id": { "type": "String", "required": true, "min": 20, "max": 20 } } } ] }, "git_lab_field": { "type": "Array", "required": true, "items": [ { "name": "EntityFieldInput", "type": "Object", "required": false, "fields": { "field_id": { "type": "String", "required": true, "min": 20, "max": 20 }, "value": { "type": "Any", "required": false } } } ] }, "git_lab_tag": { "type": "Array", "required": true, "items": [ { "name": "EntityTagInput", "type": "Object", "required": false, "fields": { "name": { "type": "String", "required": true, "max": 255 }, "value": { "type": "String", "required": false } } } ] } }}
TokenAuthCategory
{ "name": "TokenAuthCategory", "type": "Object", "required": true, "fields": { "id": { "type": "Integer", "required": true }, "user_id": { "type": "String", "required": true, "min": 20, "max": 20 }, "entity_id": { "type": "String", "required": true, "min": 20, "max": 20 }, "category_id": { "type": "String", "required": true, "min": 20, "max": 20 }, "created_at": { "type": "DateTime", "required": true }, "updated_at": { "type": "DateTime", "required": true } }}
TokenAuthField
{ "name": "TokenAuthField", "type": "Object", "required": true, "fields": { "id": { "type": "Integer", "required": true }, "user_id": { "type": "String", "required": true, "min": 20, "max": 20 }, "entity_id": { "type": "String", "required": true, "min": 20, "max": 20 }, "field_id": { "type": "String", "required": true, "min": 20, "max": 20 }, "value": { "type": "String", "required": false }, "created_at": { "type": "DateTime", "required": true }, "updated_at": { "type": "DateTime", "required": true } }}
TokenAuthTag
{ "name": "TokenAuthTag", "type": "Object", "required": true, "fields": { "id": { "type": "Integer", "required": true }, "user_id": { "type": "String", "required": true, "min": 20, "max": 20 }, "entity_id": { "type": "String", "required": true, "min": 20, "max": 20 }, "name": { "type": "String", "required": true, "max": 255 }, "value": { "type": "String", "required": false }, "created_at": { "type": "DateTime", "required": true }, "updated_at": { "type": "DateTime", "required": true } }}
TokenAuth
{ "name": "TokenAuth", "type": "Object", "required": true, "fields": { "id": { "type": "String", "required": true, "min": 20, "max": 20 }, "credential_id": { "type": "String", "required": true, "min": 20, "max": 20 }, "protocol_id": { "type": "String", "required": true, "min": 20, "max": 20 }, "token_secret_id": { "type": "String", "required": true, "min": 20, "max": 20 }, "created_at": { "type": "DateTime", "required": true }, "updated_at": { "type": "DateTime", "required": true }, "entity_id": { "type": "String", "required": true, "min": 20, "max": 20 }, "group_id": { "type": "String", "required": true, "min": 20, "max": 20 }, "user_id": { "type": "String", "required": true, "min": 20, "max": 20 }, "workspace_id": { "type": "String", "required": true, "min": 20, "max": 20 }, "group_type": { "name": "CredentialGroupType", "type": "Enum", "required": true, "valids": [ "Protocol", "Cloud", "Database", "SourceControl" ] }, "entity_type": { "name": "CredentialEntityType", "type": "Enum", "required": true, "valids": [ "AWS", "Azure", "BasicAuth", "HostBasicAuth", "Credential", "Database", "GCP", "GitHub", "GitLab", "SSH", "TokenAuth", "HostTokenAuth" ] }, "name": { "type": "String", "required": true, "max": 255 }, "description": { "type": "String", "required": false } }}
TokenAuthCreate
{ "name": "TokenAuthCreate", "type": "Object", "required": true, "fields": { "token": { "type": "String", "required": true }, "workspace_id": { "type": "String", "required": false, "min": 20, "max": 20 }, "name": { "type": "String", "required": true, "max": 255 }, "description": { "type": "String", "required": false }, "token_auth_category": { "type": "Array", "required": true, "items": [ { "name": "EntityCategoryInput", "type": "Object", "required": false, "fields": { "category_id": { "type": "String", "required": true, "min": 20, "max": 20 } } } ] }, "token_auth_field": { "type": "Array", "required": true, "items": [ { "name": "EntityFieldInput", "type": "Object", "required": false, "fields": { "field_id": { "type": "String", "required": true, "min": 20, "max": 20 }, "value": { "type": "Any", "required": false } } } ] }, "token_auth_tag": { "type": "Array", "required": true, "items": [ { "name": "EntityTagInput", "type": "Object", "required": false, "fields": { "name": { "type": "String", "required": true, "max": 255 }, "value": { "type": "String", "required": false } } } ] } }}
TokenAuthUpdate
{ "name": "TokenAuthUpdate", "type": "Object", "required": true, "fields": { "token": { "type": "String", "required": false }, "workspace_id": { "type": "String", "required": false, "min": 20, "max": 20 }, "name": { "type": "String", "required": true, "max": 255 }, "description": { "type": "String", "required": false }, "token_auth_category": { "type": "Array", "required": true, "items": [ { "name": "EntityCategoryInput", "type": "Object", "required": false, "fields": { "category_id": { "type": "String", "required": true, "min": 20, "max": 20 } } } ] }, "token_auth_field": { "type": "Array", "required": true, "items": [ { "name": "EntityFieldInput", "type": "Object", "required": false, "fields": { "field_id": { "type": "String", "required": true, "min": 20, "max": 20 }, "value": { "type": "Any", "required": false } } } ] }, "token_auth_tag": { "type": "Array", "required": true, "items": [ { "name": "EntityTagInput", "type": "Object", "required": false, "fields": { "name": { "type": "String", "required": true, "max": 255 }, "value": { "type": "String", "required": false } } } ] } }}
HostTokenAuthCategory
{ "name": "HostTokenAuthCategory", "type": "Object", "required": true, "fields": { "id": { "type": "Integer", "required": true }, "user_id": { "type": "String", "required": true, "min": 20, "max": 20 }, "entity_id": { "type": "String", "required": true, "min": 20, "max": 20 }, "category_id": { "type": "String", "required": true, "min": 20, "max": 20 }, "created_at": { "type": "DateTime", "required": true }, "updated_at": { "type": "DateTime", "required": true } }}
HostTokenAuthField
{ "name": "HostTokenAuthField", "type": "Object", "required": true, "fields": { "id": { "type": "Integer", "required": true }, "user_id": { "type": "String", "required": true, "min": 20, "max": 20 }, "entity_id": { "type": "String", "required": true, "min": 20, "max": 20 }, "field_id": { "type": "String", "required": true, "min": 20, "max": 20 }, "value": { "type": "String", "required": false }, "created_at": { "type": "DateTime", "required": true }, "updated_at": { "type": "DateTime", "required": true } }}
HostTokenAuthTag
{ "name": "HostTokenAuthTag", "type": "Object", "required": true, "fields": { "id": { "type": "Integer", "required": true }, "user_id": { "type": "String", "required": true, "min": 20, "max": 20 }, "entity_id": { "type": "String", "required": true, "min": 20, "max": 20 }, "name": { "type": "String", "required": true, "max": 255 }, "value": { "type": "String", "required": false }, "created_at": { "type": "DateTime", "required": true }, "updated_at": { "type": "DateTime", "required": true } }}
HostTokenAuth
{ "name": "HostTokenAuth", "type": "Object", "required": true, "fields": { "id": { "type": "String", "required": true, "min": 20, "max": 20 }, "credential_id": { "type": "String", "required": true, "min": 20, "max": 20 }, "protocol_id": { "type": "String", "required": true, "min": 20, "max": 20 }, "host": { "type": "String", "required": true, "max": 255 }, "token_secret_id": { "type": "String", "required": true, "min": 20, "max": 20 }, "created_at": { "type": "DateTime", "required": true }, "updated_at": { "type": "DateTime", "required": true }, "entity_id": { "type": "String", "required": true, "min": 20, "max": 20 }, "group_id": { "type": "String", "required": true, "min": 20, "max": 20 }, "user_id": { "type": "String", "required": true, "min": 20, "max": 20 }, "workspace_id": { "type": "String", "required": true, "min": 20, "max": 20 }, "group_type": { "name": "CredentialGroupType", "type": "Enum", "required": true, "valids": [ "Protocol", "Cloud", "Database", "SourceControl" ] }, "entity_type": { "name": "CredentialEntityType", "type": "Enum", "required": true, "valids": [ "AWS", "Azure", "BasicAuth", "HostBasicAuth", "Credential", "Database", "GCP", "GitHub", "GitLab", "SSH", "TokenAuth", "HostTokenAuth" ] }, "name": { "type": "String", "required": true, "max": 255 }, "description": { "type": "String", "required": false } }}
HostTokenAuthCreate
{ "name": "HostTokenAuthCreate", "type": "Object", "required": true, "fields": { "host": { "type": "String", "required": true, "max": 255 }, "token": { "type": "String", "required": true }, "workspace_id": { "type": "String", "required": false, "min": 20, "max": 20 }, "name": { "type": "String", "required": true, "max": 255 }, "description": { "type": "String", "required": false }, "host_token_auth_category": { "type": "Array", "required": true, "items": [ { "name": "EntityCategoryInput", "type": "Object", "required": false, "fields": { "category_id": { "type": "String", "required": true, "min": 20, "max": 20 } } } ] }, "host_token_auth_field": { "type": "Array", "required": true, "items": [ { "name": "EntityFieldInput", "type": "Object", "required": false, "fields": { "field_id": { "type": "String", "required": true, "min": 20, "max": 20 }, "value": { "type": "Any", "required": false } } } ] }, "host_token_auth_tag": { "type": "Array", "required": true, "items": [ { "name": "EntityTagInput", "type": "Object", "required": false, "fields": { "name": { "type": "String", "required": true, "max": 255 }, "value": { "type": "String", "required": false } } } ] } }}
HostTokenAuthUpdate
{ "name": "HostTokenAuthUpdate", "type": "Object", "required": true, "fields": { "host": { "type": "String", "required": true, "max": 255 }, "token": { "type": "String", "required": false }, "workspace_id": { "type": "String", "required": false, "min": 20, "max": 20 }, "name": { "type": "String", "required": true, "max": 255 }, "description": { "type": "String", "required": false }, "host_token_auth_category": { "type": "Array", "required": true, "items": [ { "name": "EntityCategoryInput", "type": "Object", "required": false, "fields": { "category_id": { "type": "String", "required": true, "min": 20, "max": 20 } } } ] }, "host_token_auth_field": { "type": "Array", "required": true, "items": [ { "name": "EntityFieldInput", "type": "Object", "required": false, "fields": { "field_id": { "type": "String", "required": true, "min": 20, "max": 20 }, "value": { "type": "Any", "required": false } } } ] }, "host_token_auth_tag": { "type": "Array", "required": true, "items": [ { "name": "EntityTagInput", "type": "Object", "required": false, "fields": { "name": { "type": "String", "required": true, "max": 255 }, "value": { "type": "String", "required": false } } } ] } }}
BasicAuthCategory
{ "name": "BasicAuthCategory", "type": "Object", "required": true, "fields": { "id": { "type": "Integer", "required": true }, "user_id": { "type": "String", "required": true, "min": 20, "max": 20 }, "entity_id": { "type": "String", "required": true, "min": 20, "max": 20 }, "category_id": { "type": "String", "required": true, "min": 20, "max": 20 }, "created_at": { "type": "DateTime", "required": true }, "updated_at": { "type": "DateTime", "required": true } }}
BasicAuthField
{ "name": "BasicAuthField", "type": "Object", "required": true, "fields": { "id": { "type": "Integer", "required": true }, "user_id": { "type": "String", "required": true, "min": 20, "max": 20 }, "entity_id": { "type": "String", "required": true, "min": 20, "max": 20 }, "field_id": { "type": "String", "required": true, "min": 20, "max": 20 }, "value": { "type": "String", "required": false }, "created_at": { "type": "DateTime", "required": true }, "updated_at": { "type": "DateTime", "required": true } }}
BasicAuthTag
{ "name": "BasicAuthTag", "type": "Object", "required": true, "fields": { "id": { "type": "Integer", "required": true }, "user_id": { "type": "String", "required": true, "min": 20, "max": 20 }, "entity_id": { "type": "String", "required": true, "min": 20, "max": 20 }, "name": { "type": "String", "required": true, "max": 255 }, "value": { "type": "String", "required": false }, "created_at": { "type": "DateTime", "required": true }, "updated_at": { "type": "DateTime", "required": true } }}
BasicAuth
{ "name": "BasicAuth", "type": "Object", "required": true, "fields": { "id": { "type": "String", "required": true, "min": 20, "max": 20 }, "credential_id": { "type": "String", "required": true, "min": 20, "max": 20 }, "protocol_id": { "type": "String", "required": true, "min": 20, "max": 20 }, "username_secret_id": { "type": "String", "required": true, "min": 20, "max": 20 }, "password_secret_id": { "type": "String", "required": true, "min": 20, "max": 20 }, "created_at": { "type": "DateTime", "required": true }, "updated_at": { "type": "DateTime", "required": true }, "entity_id": { "type": "String", "required": true, "min": 20, "max": 20 }, "group_id": { "type": "String", "required": true, "min": 20, "max": 20 }, "user_id": { "type": "String", "required": true, "min": 20, "max": 20 }, "workspace_id": { "type": "String", "required": true, "min": 20, "max": 20 }, "group_type": { "name": "CredentialGroupType", "type": "Enum", "required": true, "valids": [ "Protocol", "Cloud", "Database", "SourceControl" ] }, "entity_type": { "name": "CredentialEntityType", "type": "Enum", "required": true, "valids": [ "AWS", "Azure", "BasicAuth", "HostBasicAuth", "Credential", "Database", "GCP", "GitHub", "GitLab", "SSH", "TokenAuth", "HostTokenAuth" ] }, "name": { "type": "String", "required": true, "max": 255 }, "description": { "type": "String", "required": false } }}
BasicAuthCreate
{ "name": "BasicAuthCreate", "type": "Object", "required": true, "fields": { "username": { "type": "String", "required": true }, "password": { "type": "String", "required": true }, "workspace_id": { "type": "String", "required": false, "min": 20, "max": 20 }, "name": { "type": "String", "required": true, "max": 255 }, "description": { "type": "String", "required": false }, "basic_auth_category": { "type": "Array", "required": true, "items": [ { "name": "EntityCategoryInput", "type": "Object", "required": false, "fields": { "category_id": { "type": "String", "required": true, "min": 20, "max": 20 } } } ] }, "basic_auth_field": { "type": "Array", "required": true, "items": [ { "name": "EntityFieldInput", "type": "Object", "required": false, "fields": { "field_id": { "type": "String", "required": true, "min": 20, "max": 20 }, "value": { "type": "Any", "required": false } } } ] }, "basic_auth_tag": { "type": "Array", "required": true, "items": [ { "name": "EntityTagInput", "type": "Object", "required": false, "fields": { "name": { "type": "String", "required": true, "max": 255 }, "value": { "type": "String", "required": false } } } ] } }}
BasicAuthUpdate
{ "name": "BasicAuthUpdate", "type": "Object", "required": true, "fields": { "username": { "type": "String", "required": false }, "password": { "type": "String", "required": false }, "workspace_id": { "type": "String", "required": false, "min": 20, "max": 20 }, "name": { "type": "String", "required": true, "max": 255 }, "description": { "type": "String", "required": false }, "basic_auth_category": { "type": "Array", "required": true, "items": [ { "name": "EntityCategoryInput", "type": "Object", "required": false, "fields": { "category_id": { "type": "String", "required": true, "min": 20, "max": 20 } } } ] }, "basic_auth_field": { "type": "Array", "required": true, "items": [ { "name": "EntityFieldInput", "type": "Object", "required": false, "fields": { "field_id": { "type": "String", "required": true, "min": 20, "max": 20 }, "value": { "type": "Any", "required": false } } } ] }, "basic_auth_tag": { "type": "Array", "required": true, "items": [ { "name": "EntityTagInput", "type": "Object", "required": false, "fields": { "name": { "type": "String", "required": true, "max": 255 }, "value": { "type": "String", "required": false } } } ] } }}
HostBasicAuthCategory
{ "name": "HostBasicAuthCategory", "type": "Object", "required": true, "fields": { "id": { "type": "Integer", "required": true }, "user_id": { "type": "String", "required": true, "min": 20, "max": 20 }, "entity_id": { "type": "String", "required": true, "min": 20, "max": 20 }, "category_id": { "type": "String", "required": true, "min": 20, "max": 20 }, "created_at": { "type": "DateTime", "required": true }, "updated_at": { "type": "DateTime", "required": true } }}
HostBasicAuthField
{ "name": "HostBasicAuthField", "type": "Object", "required": true, "fields": { "id": { "type": "Integer", "required": true }, "user_id": { "type": "String", "required": true, "min": 20, "max": 20 }, "entity_id": { "type": "String", "required": true, "min": 20, "max": 20 }, "field_id": { "type": "String", "required": true, "min": 20, "max": 20 }, "value": { "type": "String", "required": false }, "created_at": { "type": "DateTime", "required": true }, "updated_at": { "type": "DateTime", "required": true } }}
HostBasicAuthTag
{ "name": "HostBasicAuthTag", "type": "Object", "required": true, "fields": { "id": { "type": "Integer", "required": true }, "user_id": { "type": "String", "required": true, "min": 20, "max": 20 }, "entity_id": { "type": "String", "required": true, "min": 20, "max": 20 }, "name": { "type": "String", "required": true, "max": 255 }, "value": { "type": "String", "required": false }, "created_at": { "type": "DateTime", "required": true }, "updated_at": { "type": "DateTime", "required": true } }}
HostBasicAuth
{ "name": "HostBasicAuth", "type": "Object", "required": true, "fields": { "id": { "type": "String", "required": true, "min": 20, "max": 20 }, "credential_id": { "type": "String", "required": true, "min": 20, "max": 20 }, "protocol_id": { "type": "String", "required": true, "min": 20, "max": 20 }, "host": { "type": "String", "required": true, "max": 255 }, "username_secret_id": { "type": "String", "required": true, "min": 20, "max": 20 }, "password_secret_id": { "type": "String", "required": true, "min": 20, "max": 20 }, "created_at": { "type": "DateTime", "required": true }, "updated_at": { "type": "DateTime", "required": true }, "entity_id": { "type": "String", "required": true, "min": 20, "max": 20 }, "group_id": { "type": "String", "required": true, "min": 20, "max": 20 }, "user_id": { "type": "String", "required": true, "min": 20, "max": 20 }, "workspace_id": { "type": "String", "required": true, "min": 20, "max": 20 }, "group_type": { "name": "CredentialGroupType", "type": "Enum", "required": true, "valids": [ "Protocol", "Cloud", "Database", "SourceControl" ] }, "entity_type": { "name": "CredentialEntityType", "type": "Enum", "required": true, "valids": [ "AWS", "Azure", "BasicAuth", "HostBasicAuth", "Credential", "Database", "GCP", "GitHub", "GitLab", "SSH", "TokenAuth", "HostTokenAuth" ] }, "name": { "type": "String", "required": true, "max": 255 }, "description": { "type": "String", "required": false } }}
HostBasicAuthCreate
{ "name": "HostBasicAuthCreate", "type": "Object", "required": true, "fields": { "host": { "type": "String", "required": true, "max": 255 }, "username": { "type": "String", "required": true }, "password": { "type": "String", "required": true }, "workspace_id": { "type": "String", "required": false, "min": 20, "max": 20 }, "name": { "type": "String", "required": true, "max": 255 }, "description": { "type": "String", "required": false }, "host_basic_auth_category": { "type": "Array", "required": true, "items": [ { "name": "EntityCategoryInput", "type": "Object", "required": false, "fields": { "category_id": { "type": "String", "required": true, "min": 20, "max": 20 } } } ] }, "host_basic_auth_field": { "type": "Array", "required": true, "items": [ { "name": "EntityFieldInput", "type": "Object", "required": false, "fields": { "field_id": { "type": "String", "required": true, "min": 20, "max": 20 }, "value": { "type": "Any", "required": false } } } ] }, "host_basic_auth_tag": { "type": "Array", "required": true, "items": [ { "name": "EntityTagInput", "type": "Object", "required": false, "fields": { "name": { "type": "String", "required": true, "max": 255 }, "value": { "type": "String", "required": false } } } ] } }}
HostBasicAuthUpdate
{ "name": "HostBasicAuthUpdate", "type": "Object", "required": true, "fields": { "host": { "type": "String", "required": true, "max": 255 }, "username": { "type": "String", "required": false }, "password": { "type": "String", "required": false }, "workspace_id": { "type": "String", "required": false, "min": 20, "max": 20 }, "name": { "type": "String", "required": true, "max": 255 }, "description": { "type": "String", "required": false }, "host_basic_auth_category": { "type": "Array", "required": true, "items": [ { "name": "EntityCategoryInput", "type": "Object", "required": false, "fields": { "category_id": { "type": "String", "required": true, "min": 20, "max": 20 } } } ] }, "host_basic_auth_field": { "type": "Array", "required": true, "items": [ { "name": "EntityFieldInput", "type": "Object", "required": false, "fields": { "field_id": { "type": "String", "required": true, "min": 20, "max": 20 }, "value": { "type": "Any", "required": false } } } ] }, "host_basic_auth_tag": { "type": "Array", "required": true, "items": [ { "name": "EntityTagInput", "type": "Object", "required": false, "fields": { "name": { "type": "String", "required": true, "max": 255 }, "value": { "type": "String", "required": false } } } ] } }}
SshCategory
{ "name": "SshCategory", "type": "Object", "required": true, "fields": { "id": { "type": "Integer", "required": true }, "user_id": { "type": "String", "required": true, "min": 20, "max": 20 }, "entity_id": { "type": "String", "required": true, "min": 20, "max": 20 }, "category_id": { "type": "String", "required": true, "min": 20, "max": 20 }, "created_at": { "type": "DateTime", "required": true }, "updated_at": { "type": "DateTime", "required": true } }}
SshField
{ "name": "SshField", "type": "Object", "required": true, "fields": { "id": { "type": "Integer", "required": true }, "user_id": { "type": "String", "required": true, "min": 20, "max": 20 }, "entity_id": { "type": "String", "required": true, "min": 20, "max": 20 }, "field_id": { "type": "String", "required": true, "min": 20, "max": 20 }, "value": { "type": "String", "required": false }, "created_at": { "type": "DateTime", "required": true }, "updated_at": { "type": "DateTime", "required": true } }}
SshTag
{ "name": "SshTag", "type": "Object", "required": true, "fields": { "id": { "type": "Integer", "required": true }, "user_id": { "type": "String", "required": true, "min": 20, "max": 20 }, "entity_id": { "type": "String", "required": true, "min": 20, "max": 20 }, "name": { "type": "String", "required": true, "max": 255 }, "value": { "type": "String", "required": false }, "created_at": { "type": "DateTime", "required": true }, "updated_at": { "type": "DateTime", "required": true } }}
Ssh
{ "name": "Ssh", "type": "Object", "required": true, "fields": { "id": { "type": "String", "required": true, "min": 20, "max": 20 }, "credential_id": { "type": "String", "required": true, "min": 20, "max": 20 }, "protocol_id": { "type": "String", "required": true, "min": 20, "max": 20 }, "host": { "type": "String", "required": true, "max": 255 }, "port": { "type": "Integer", "required": true }, "auth_type": { "name": "SshAuthType", "type": "Enum", "required": true, "valids": [ "Password", "PrivateKey" ] }, "username_secret_id": { "type": "String", "required": true, "min": 20, "max": 20 }, "password_secret_id": { "type": "String", "required": false, "min": 20, "max": 20 }, "private_key_secret_id": { "type": "String", "required": false, "min": 20, "max": 20 }, "private_key_passphrase_secret_id": { "type": "String", "required": false, "min": 20, "max": 20 }, "fingerprint_secret_id": { "type": "String", "required": false, "min": 20, "max": 20 }, "created_at": { "type": "DateTime", "required": true }, "updated_at": { "type": "DateTime", "required": true }, "entity_id": { "type": "String", "required": true, "min": 20, "max": 20 }, "group_id": { "type": "String", "required": true, "min": 20, "max": 20 }, "user_id": { "type": "String", "required": true, "min": 20, "max": 20 }, "workspace_id": { "type": "String", "required": true, "min": 20, "max": 20 }, "group_type": { "name": "CredentialGroupType", "type": "Enum", "required": true, "valids": [ "Protocol", "Cloud", "Database", "SourceControl" ] }, "entity_type": { "name": "CredentialEntityType", "type": "Enum", "required": true, "valids": [ "AWS", "Azure", "BasicAuth", "HostBasicAuth", "Credential", "Database", "GCP", "GitHub", "GitLab", "SSH", "TokenAuth", "HostTokenAuth" ] }, "name": { "type": "String", "required": true, "max": 255 }, "description": { "type": "String", "required": false } }}
SSHCreate
{ "name": "SSHCreate", "type": "Object", "required": true, "fields": { "host": { "type": "String", "required": true, "max": 255 }, "port": { "type": "Integer", "required": true }, "auth_type": { "name": "SshAuthType", "type": "Enum", "required": true, "valids": [ "Password", "PrivateKey" ] }, "username": { "type": "String", "required": false }, "password": { "type": "String", "required": false }, "private_key": { "type": "String", "required": false }, "private_key_passphrase": { "type": "String", "required": false }, "fingerprint": { "type": "String", "required": false }, "workspace_id": { "type": "String", "required": false, "min": 20, "max": 20 }, "name": { "type": "String", "required": true, "max": 255 }, "description": { "type": "String", "required": false }, "ssh_category": { "type": "Array", "required": true, "items": [ { "name": "EntityCategoryInput", "type": "Object", "required": false, "fields": { "category_id": { "type": "String", "required": true, "min": 20, "max": 20 } } } ] }, "ssh_field": { "type": "Array", "required": true, "items": [ { "name": "EntityFieldInput", "type": "Object", "required": false, "fields": { "field_id": { "type": "String", "required": true, "min": 20, "max": 20 }, "value": { "type": "Any", "required": false } } } ] }, "ssh_tag": { "type": "Array", "required": true, "items": [ { "name": "EntityTagInput", "type": "Object", "required": false, "fields": { "name": { "type": "String", "required": true, "max": 255 }, "value": { "type": "String", "required": false } } } ] } }}
SSHUpdate
{ "name": "SSHUpdate", "type": "Object", "required": true, "fields": { "host": { "type": "String", "required": true, "max": 255 }, "port": { "type": "Integer", "required": true }, "username": { "type": "String", "required": false }, "password": { "type": "String", "required": false }, "private_key": { "type": "String", "required": false }, "private_key_passphrase": { "type": "String", "required": false }, "fingerprint": { "type": "String", "required": false }, "workspace_id": { "type": "String", "required": false, "min": 20, "max": 20 }, "name": { "type": "String", "required": true, "max": 255 }, "description": { "type": "String", "required": false }, "ssh_category": { "type": "Array", "required": true, "items": [ { "name": "EntityCategoryInput", "type": "Object", "required": false, "fields": { "category_id": { "type": "String", "required": true, "min": 20, "max": 20 } } } ] }, "ssh_field": { "type": "Array", "required": true, "items": [ { "name": "EntityFieldInput", "type": "Object", "required": false, "fields": { "field_id": { "type": "String", "required": true, "min": 20, "max": 20 }, "value": { "type": "Any", "required": false } } } ] }, "ssh_tag": { "type": "Array", "required": true, "items": [ { "name": "EntityTagInput", "type": "Object", "required": false, "fields": { "name": { "type": "String", "required": true, "max": 255 }, "value": { "type": "String", "required": false } } } ] } }}
Enums
CredentialGroupType
Protocol
Cloud
Database
SourceControl
CredentialEntityType
AWS
Azure
BasicAuth
HostBasicAuth
Credential
Database
GCP
GitHub
GitLab
SSH
TokenAuth
HostTokenAuth
GitHubType
Password
PATClassic
PATFineGrained
OAuthApp
GitHubApp
SSH
GitLabType
Password
PAT
OAuth
SSH
SshAuthType
Password
PrivateKey
Namira Software Corporation
©Copyright 2010 to 2026 Namira Software Corporation. All rights reserved.