ProjectService
- GETGet v1* iampolicies:batchget
- GETGet v1projects
- POSTPost v1projects
- GETGet v1projects 1
- DELDelete v1projects
- PATCHPatch v1projects
- POSTPost v1projects webhooks :removewebhook
- PATCHPatch v1projects webhooks :updatewebhook
- POSTPost v1projects :addwebhook
- GETGet v1projects :getiampolicy
- POSTPost v1projects :setiampolicy
- POSTPost v1projects :testwebhook
- POSTPost v1projects :undelete
- POSTPost v1projects:batchdelete
- POSTPost v1projects:search
ActuatorService
AuditLogService
AuthService
OrgPolicyService
- GETGet v1environments policies
- POSTPost v1environments policies
- GETGet v1environments policies 1
- DELDelete v1environments policies
- PATCHPatch v1environments policies
- GETGet v1instances databases policies
- POSTPost v1instances databases policies
- GETGet v1instances databases policies 1
- DELDelete v1instances databases policies
- PATCHPatch v1instances databases policies
- GETGet v1instances policies
- POSTPost v1instances policies
- GETGet v1instances policies 1
- DELDelete v1instances policies
- PATCHPatch v1instances policies
- GETGet v1policies
- POSTPost v1policies
- GETGet v1policies 1
- DELDelete v1policies
- PATCHPatch v1policies
- GETGet v1projects policies
- POSTPost v1projects policies
- GETGet v1projects policies 1
- DELDelete v1projects policies
- PATCHPatch v1projects policies
GroupService
IdentityProviderService
InstanceService
- GETGet v1instances
- POSTPost v1instances
- GETGet v1instances 1
- DELDelete v1instances
- PATCHPatch v1instances
- POSTPost v1instances :adddatasource
- POSTPost v1instances :databases
- POSTPost v1instances :removedatasource
- POSTPost v1instances :sync
- POSTPost v1instances :undelete
- PATCHPatch v1instances :updatedatasource
- POSTPost v1instances:batchsync
- POSTPost v1instances:batchupdate
DatabaseService
- GETGet v1instances databases
- GETGet v1instances databases 1
- PATCHPatch v1instances databases
- GETGet v1instances databases changelogs
- GETGet v1instances databases changelogs 1
- POSTPost v1instances databases changelogs :diffschema
- GETGet v1instances databases metadata
- GETGet v1instances databases schema
- GETGet v1instances databases schemastring
- GETGet v1instances databases sdlschema
- POSTPost v1instances databases :diffschema
- POSTPost v1instances databases :sync
- GETGet v1instances databases:batchget
- POSTPost v1instances databases:batchsync
- POSTPost v1instances databases:batchupdate
- GETGet v1projects databases
- GETGet v1projects databases:batchget
- GETGet v1workspaces databases
DatabaseCatalogService
RevisionService
SQLService
InstanceRoleService
DatabaseGroupService
IssueService
- GETGet v1projects issues
- POSTPost v1projects issues
- GETGet v1projects issues 1
- PATCHPatch v1projects issues
- GETGet v1projects issues issuecomments
- POSTPost v1projects issues :approve
- POSTPost v1projects issues :comment
- PATCHPatch v1projects issues :comment
- POSTPost v1projects issues :reject
- POSTPost v1projects issues :request
- POSTPost v1projects issues:batchupdatestatus
- POSTPost v1projects issues:search
PlanService
ReleaseService
RolloutService
- GETGet v1projects rollouts
- POSTPost v1projects rollouts
- GETGet v1projects rollouts 1
- GETGet v1projects rollouts stages tasks taskruns
- GETGet v1projects rollouts stages tasks taskruns 1
- GETGet v1projects rollouts stages tasks taskruns log
- GETGet v1projects rollouts stages tasks taskruns session
- POSTPost v1projects rollouts stages tasks taskruns :previewrollback
- POSTPost v1projects rollouts stages tasks taskruns:batchcancel
- POSTPost v1projects rollouts stages tasks:batchrun
- POSTPost v1projects rollouts stages tasks:batchskip
- POSTPost v1projects :previewrollout
SheetService
ReviewConfigService
SubscriptionService
UserService
WorksheetService
{
"token": "<string>",
"mfaTempToken": "<string>",
"requireResetPassword": true,
"user": {
"name": "<string>",
"state": "STATE_UNSPECIFIED",
"email": "<string>",
"title": "<string>",
"userType": "USER_TYPE_UNSPECIFIED",
"mfaEnabled": true,
"tempOtpSecret": "<string>",
"tempRecoveryCodes": [
"<string>"
],
"tempOtpSecretCreatedTime": "2023-11-07T05:31:56Z",
"phone": "<string>",
"profile": {
"lastLoginTime": "2023-11-07T05:31:56Z",
"lastChangePasswordTime": "2023-11-07T05:31:56Z",
"source": "<string>"
},
"groups": [
"<string>"
]
}
}Post v1authlogin
Authenticates a user and returns access tokens. Permissions required: None
{
"token": "<string>",
"mfaTempToken": "<string>",
"requireResetPassword": true,
"user": {
"name": "<string>",
"state": "STATE_UNSPECIFIED",
"email": "<string>",
"title": "<string>",
"userType": "USER_TYPE_UNSPECIFIED",
"mfaEnabled": true,
"tempOtpSecret": "<string>",
"tempRecoveryCodes": [
"<string>"
],
"tempOtpSecretCreatedTime": "2023-11-07T05:31:56Z",
"phone": "<string>",
"profile": {
"lastLoginTime": "2023-11-07T05:31:56Z",
"lastChangePasswordTime": "2023-11-07T05:31:56Z",
"source": "<string>"
},
"groups": [
"<string>"
]
}
}Body
User's email address.
User's password for authentication.
If web is set, we will set access token, refresh token, and user to the cookie.
The name of the identity provider. Format: idps/{idp}
The idp_context is using to get the user information from identity provider.
Show child attributes
Show child attributes
The otp_code is used to verify the user's identity by MFA.
The recovery_code is used to recovery the user's identity with MFA.
The mfa_temp_token is used to verify the user's identity by MFA.
Response
OK
Access token for authenticated requests.
Temporary token for MFA verification.
Whether user must reset password before continuing.
The user from the successful login.
Show child attributes
Show child attributes
The name of the user. Format: users/{user}. {user} is a system-generated unique ID.
The lifecycle state of the user account.
STATE_UNSPECIFIED, ACTIVE, DELETED The email address of the user, used for login and notifications.
The display title or full name of the user.
The type of user account.
USER_TYPE_UNSPECIFIED, USER, SYSTEM_BOT, SERVICE_ACCOUNT The mfa_enabled flag means if the user has enabled MFA.
Temporary OTP secret used during MFA setup and regeneration.
Temporary recovery codes used during MFA setup and regeneration.
Timestamp when temp_otp_secret was created. Used by frontend to show countdown timer.
Should be a valid E.164 compliant phone number. Could be empty.
User profile metadata.
Show child attributes
Show child attributes
The last time the user successfully logged in.
The last time the user changed their password.
source means where the user comes from. For now we support Entra ID SCIM sync, so the source could be Entra ID.
The groups for the user. Format: groups/{email}
Was this page helpful?