zitadel/pkg/auth/api/grpc/auth.swagger.json

{
  "swagger": "2.0",
  "info": {
    "title": "Auth API",
    "version": "0.1",
    "contact": {
      "url": "https://github.com/caos/zitadel/pkg/auth"
    }
  },
  "schemes": [
    "https"
  ],
  "consumes": [
    "application/json",
    "application/grpc"
  ],
  "produces": [
    "application/json",
    "application/grpc"
  ],
  "paths": {
    "/global/projectorgs/_search": {
      "post": {
        "operationId": "SearchMyProjectOrgs",
        "responses": {
          "200": {
            "description": "A successful response.",
            "schema": {
              "$ref": "#/definitions/v1MyProjectOrgSearchResponse"
            }
          }
        },
        "parameters": [
          {
            "name": "body",
            "in": "body",
            "required": true,
            "schema": {
              "$ref": "#/definitions/v1MyProjectOrgSearchRequest"
            }
          }
        ],
        "tags": [
          "AuthService"
        ]
      }
    },
    "/healthz": {
      "get": {
        "summary": "Readiness",
        "operationId": "Healthz",
        "responses": {
          "200": {
            "description": "A successful response.",
            "schema": {
              "properties": {}
            }
          }
        },
        "tags": [
          "AuthService"
        ]
      }
    },
    "/me/usersessions": {
      "get": {
        "summary": "Authorization",
        "operationId": "GetMyUserSessions",
        "responses": {
          "200": {
            "description": "A successful response.",
            "schema": {
              "$ref": "#/definitions/v1UserSessionViews"
            }
          }
        },
        "tags": [
          "AuthService"
        ]
      }
    },
    "/permissions/zitadel/me": {
      "get": {
        "summary": "Permission",
        "operationId": "GetMyZitadelPermissions",
        "responses": {
          "200": {
            "description": "A successful response.",
            "schema": {
              "$ref": "#/definitions/v1MyPermissions"
            }
          }
        },
        "tags": [
          "AuthService"
        ]
      }
    },
    "/ready": {
      "get": {
        "operationId": "Ready",
        "responses": {
          "200": {
            "description": "A successful response.",
            "schema": {
              "properties": {}
            }
          }
        },
        "tags": [
          "AuthService"
        ]
      }
    },
    "/usergrants/me/_search": {
      "post": {
        "operationId": "SearchMyUserGrant",
        "responses": {
          "200": {
            "description": "A successful response.",
            "schema": {
              "$ref": "#/definitions/v1UserGrantSearchResponse"
            }
          }
        },
        "parameters": [
          {
            "name": "body",
            "in": "body",
            "required": true,
            "schema": {
              "$ref": "#/definitions/v1UserGrantSearchRequest"
            }
          }
        ],
        "tags": [
          "AuthService"
        ]
      }
    },
    "/users/me/address": {
      "get": {
        "operationId": "GetMyUserAddress",
        "responses": {
          "200": {
            "description": "A successful response.",
            "schema": {
              "$ref": "#/definitions/v1UserAddress"
            }
          }
        },
        "tags": [
          "AuthService"
        ]
      },
      "put": {
        "operationId": "UpdateMyUserAddress",
        "responses": {
          "200": {
            "description": "A successful response.",
            "schema": {
              "$ref": "#/definitions/v1UserAddress"
            }
          }
        },
        "parameters": [
          {
            "name": "body",
            "in": "body",
            "required": true,
            "schema": {
              "$ref": "#/definitions/v1UpdateUserAddressRequest"
            }
          }
        ],
        "tags": [
          "AuthService"
        ]
      }
    },
    "/users/me/email": {
      "get": {
        "operationId": "GetMyUserEmail",
        "responses": {
          "200": {
            "description": "A successful response.",
            "schema": {
              "$ref": "#/definitions/v1UserEmail"
            }
          }
        },
        "tags": [
          "AuthService"
        ]
      },
      "put": {
        "operationId": "ChangeMyUserEmail",
        "responses": {
          "200": {
            "description": "A successful response.",
            "schema": {
              "$ref": "#/definitions/v1UserEmail"
            }
          }
        },
        "parameters": [
          {
            "name": "body",
            "in": "body",
            "required": true,
            "schema": {
              "$ref": "#/definitions/v1UpdateUserEmailRequest"
            }
          }
        ],
        "tags": [
          "AuthService"
        ]
      }
    },
    "/users/me/email/_resendverification": {
      "post": {
        "operationId": "ResendMyEmailVerificationMail",
        "responses": {
          "200": {
            "description": "A successful response.",
            "schema": {
              "properties": {}
            }
          }
        },
        "parameters": [
          {
            "name": "body",
            "in": "body",
            "required": true,
            "schema": {
              "properties": {}
            }
          }
        ],
        "tags": [
          "AuthService"
        ]
      }
    },
    "/users/me/email/_verify": {
      "post": {
        "operationId": "VerifyMyUserEmail",
        "responses": {
          "200": {
            "description": "A successful response.",
            "schema": {
              "properties": {}
            }
          }
        },
        "parameters": [
          {
            "name": "body",
            "in": "body",
            "required": true,
            "schema": {
              "$ref": "#/definitions/v1VerifyMyUserEmailRequest"
            }
          }
        ],
        "tags": [
          "AuthService"
        ]
      }
    },
    "/users/me/mfa/otp": {
      "delete": {
        "operationId": "RemoveMfaOTP",
        "responses": {
          "200": {
            "description": "A successful response.",
            "schema": {
              "properties": {}
            }
          }
        },
        "tags": [
          "AuthService"
        ]
      },
      "post": {
        "summary": "MFA",
        "operationId": "AddMfaOTP",
        "responses": {
          "200": {
            "description": "A successful response.",
            "schema": {
              "$ref": "#/definitions/v1MfaOtpResponse"
            }
          }
        },
        "parameters": [
          {
            "name": "body",
            "in": "body",
            "required": true,
            "schema": {
              "properties": {}
            }
          }
        ],
        "tags": [
          "AuthService"
        ]
      }
    },
    "/users/me/mfa/otp/_verify": {
      "put": {
        "operationId": "VerifyMfaOTP",
        "responses": {
          "200": {
            "description": "A successful response.",
            "schema": {
              "properties": {}
            }
          }
        },
        "parameters": [
          {
            "name": "body",
            "in": "body",
            "required": true,
            "schema": {
              "$ref": "#/definitions/v1VerifyMfaOtp"
            }
          }
        ],
        "tags": [
          "AuthService"
        ]
      }
    },
    "/users/me/mfas": {
      "get": {
        "operationId": "GetMyMfas",
        "responses": {
          "200": {
            "description": "A successful response.",
            "schema": {
              "$ref": "#/definitions/v1MultiFactors"
            }
          }
        },
        "tags": [
          "AuthService"
        ]
      }
    },
    "/users/me/passwords/_change": {
      "put": {
        "summary": "Password",
        "operationId": "ChangeMyPassword",
        "responses": {
          "200": {
            "description": "A successful response.",
            "schema": {
              "properties": {}
            }
          }
        },
        "parameters": [
          {
            "name": "body",
            "in": "body",
            "required": true,
            "schema": {
              "$ref": "#/definitions/v1PasswordChange"
            }
          }
        ],
        "tags": [
          "AuthService"
        ]
      }
    },
    "/users/me/phone": {
      "get": {
        "operationId": "GetMyUserPhone",
        "responses": {
          "200": {
            "description": "A successful response.",
            "schema": {
              "$ref": "#/definitions/v1UserPhone"
            }
          }
        },
        "tags": [
          "AuthService"
        ]
      },
      "put": {
        "operationId": "ChangeMyUserPhone",
        "responses": {
          "200": {
            "description": "A successful response.",
            "schema": {
              "$ref": "#/definitions/v1UserPhone"
            }
          }
        },
        "parameters": [
          {
            "name": "body",
            "in": "body",
            "required": true,
            "schema": {
              "$ref": "#/definitions/v1UpdateUserPhoneRequest"
            }
          }
        ],
        "tags": [
          "AuthService"
        ]
      }
    },
    "/users/me/phone/_resendverification": {
      "post": {
        "operationId": "ResendMyPhoneVerificationCode",
        "responses": {
          "200": {
            "description": "A successful response.",
            "schema": {
              "properties": {}
            }
          }
        },
        "parameters": [
          {
            "name": "body",
            "in": "body",
            "required": true,
            "schema": {
              "properties": {}
            }
          }
        ],
        "tags": [
          "AuthService"
        ]
      }
    },
    "/users/me/phone/_verify": {
      "post": {
        "operationId": "VerifyMyUserPhone",
        "responses": {
          "200": {
            "description": "A successful response.",
            "schema": {
              "properties": {}
            }
          }
        },
        "parameters": [
          {
            "name": "body",
            "in": "body",
            "required": true,
            "schema": {
              "$ref": "#/definitions/v1VerifyUserPhoneRequest"
            }
          }
        ],
        "tags": [
          "AuthService"
        ]
      }
    },
    "/users/me/profile": {
      "get": {
        "summary": "User",
        "operationId": "GetMyUserProfile",
        "responses": {
          "200": {
            "description": "A successful response.",
            "schema": {
              "$ref": "#/definitions/v1UserProfile"
            }
          }
        },
        "tags": [
          "AuthService"
        ]
      },
      "put": {
        "operationId": "UpdateMyUserProfile",
        "responses": {
          "200": {
            "description": "A successful response.",
            "schema": {
              "$ref": "#/definitions/v1UserProfile"
            }
          }
        },
        "parameters": [
          {
            "name": "body",
            "in": "body",
            "required": true,
            "schema": {
              "$ref": "#/definitions/v1UpdateUserProfileRequest"
            }
          }
        ],
        "tags": [
          "AuthService"
        ]
      }
    },
    "/validate": {
      "get": {
        "operationId": "Validate",
        "responses": {
          "200": {
            "description": "A successful response.",
            "schema": {
              "type": "object"
            }
          }
        },
        "tags": [
          "AuthService"
        ]
      }
    }
  },
  "definitions": {
    "protobufNullValue": {
      "type": "string",
      "enum": [
        "NULL_VALUE"
      ],
      "default": "NULL_VALUE",
      "description": "`NullValue` is a singleton enumeration to represent the null value for the\n`Value` type union.\n\n The JSON representation for `NullValue` is JSON `null`.\n\n - NULL_VALUE: Null value."
    },
    "v1Gender": {
      "type": "string",
      "enum": [
        "GENDER_UNSPECIFIED",
        "GENDER_FEMALE",
        "GENDER_MALE",
        "GENDER_DIVERSE"
      ],
      "default": "GENDER_UNSPECIFIED"
    },
    "v1MFAState": {
      "type": "string",
      "enum": [
        "MFASTATE_UNSPECIFIED",
        "MFASTATE_NOT_READY",
        "MFASTATE_READY",
        "MFASTATE_REMOVED"
      ],
      "default": "MFASTATE_UNSPECIFIED"
    },
    "v1MfaOtpResponse": {
      "type": "object",
      "properties": {
        "user_id": {
          "type": "string"
        },
        "url": {
          "type": "string"
        },
        "secret": {
          "type": "string"
        },
        "state": {
          "$ref": "#/definitions/v1MFAState"
        }
      }
    },
    "v1MfaType": {
      "type": "string",
      "enum": [
        "MFATYPE_UNSPECIFIED",
        "MFATYPE_SMS",
        "MFATYPE_OTP"
      ],
      "default": "MFATYPE_UNSPECIFIED"
    },
    "v1MultiFactor": {
      "type": "object",
      "properties": {
        "type": {
          "$ref": "#/definitions/v1MfaType"
        },
        "state": {
          "$ref": "#/definitions/v1MFAState"
        }
      }
    },
    "v1MultiFactors": {
      "type": "object",
      "properties": {
        "mfas": {
          "type": "array",
          "items": {
            "$ref": "#/definitions/v1MultiFactor"
          }
        }
      }
    },
    "v1MyPermissions": {
      "type": "object",
      "properties": {
        "permissions": {
          "type": "array",
          "items": {
            "type": "string"
          }
        }
      }
    },
    "v1MyProjectOrgSearchKey": {
      "type": "string",
      "enum": [
        "MYPROJECTORGSEARCHKEY_UNSPECIFIED",
        "MYPROJECTORGSEARCHKEY_ORG_NAME"
      ],
      "default": "MYPROJECTORGSEARCHKEY_UNSPECIFIED"
    },
    "v1MyProjectOrgSearchQuery": {
      "type": "object",
      "properties": {
        "key": {
          "$ref": "#/definitions/v1MyProjectOrgSearchKey"
        },
        "method": {
          "$ref": "#/definitions/v1SearchMethod"
        },
        "value": {
          "type": "string"
        }
      }
    },
    "v1MyProjectOrgSearchRequest": {
      "type": "object",
      "properties": {
        "offset": {
          "type": "string",
          "format": "uint64"
        },
        "limit": {
          "type": "string",
          "format": "uint64"
        },
        "asc": {
          "type": "boolean",
          "format": "boolean"
        },
        "queries": {
          "type": "array",
          "items": {
            "$ref": "#/definitions/v1MyProjectOrgSearchQuery"
          }
        }
      }
    },
    "v1MyProjectOrgSearchResponse": {
      "type": "object",
      "properties": {
        "offset": {
          "type": "string",
          "format": "uint64"
        },
        "limit": {
          "type": "string",
          "format": "uint64"
        },
        "total_result": {
          "type": "string",
          "format": "uint64"
        },
        "result": {
          "type": "array",
          "items": {
            "$ref": "#/definitions/v1Org"
          }
        }
      }
    },
    "v1Org": {
      "type": "object",
      "properties": {
        "id": {
          "type": "string"
        },
        "name": {
          "type": "string"
        }
      }
    },
    "v1PasswordChange": {
      "type": "object",
      "properties": {
        "old_password": {
          "type": "string"
        },
        "new_password": {
          "type": "string"
        }
      }
    },
    "v1SearchMethod": {
      "type": "string",
      "enum": [
        "SEARCHMETHOD_EQUALS",
        "SEARCHMETHOD_STARTS_WITH",
        "SEARCHMETHOD_CONTAINS",
        "SEARCHMETHOD_EQUALS_IGNORE_CASE",
        "SEARCHMETHOD_STARTS_WITH_IGNORE_CASE",
        "SEARCHMETHOD_CONTAINS_IGNORE_CASE"
      ],
      "default": "SEARCHMETHOD_EQUALS"
    },
    "v1UpdateUserAddressRequest": {
      "type": "object",
      "properties": {
        "country": {
          "type": "string"
        },
        "locality": {
          "type": "string"
        },
        "postal_code": {
          "type": "string"
        },
        "region": {
          "type": "string"
        },
        "street_address": {
          "type": "string"
        }
      }
    },
    "v1UpdateUserEmailRequest": {
      "type": "object",
      "properties": {
        "email": {
          "type": "string"
        }
      }
    },
    "v1UpdateUserPhoneRequest": {
      "type": "object",
      "properties": {
        "phone": {
          "type": "string"
        }
      }
    },
    "v1UpdateUserProfileRequest": {
      "type": "object",
      "properties": {
        "first_name": {
          "type": "string"
        },
        "last_name": {
          "type": "string"
        },
        "nick_name": {
          "type": "string"
        },
        "display_name": {
          "type": "string"
        },
        "preferred_language": {
          "type": "string"
        },
        "gender": {
          "$ref": "#/definitions/v1Gender"
        }
      }
    },
    "v1UserAddress": {
      "type": "object",
      "properties": {
        "id": {
          "type": "string"
        },
        "country": {
          "type": "string"
        },
        "locality": {
          "type": "string"
        },
        "postal_code": {
          "type": "string"
        },
        "region": {
          "type": "string"
        },
        "street_address": {
          "type": "string"
        },
        "sequence": {
          "type": "string",
          "format": "uint64"
        },
        "creation_date": {
          "type": "string",
          "format": "date-time"
        },
        "change_date": {
          "type": "string",
          "format": "date-time"
        }
      }
    },
    "v1UserEmail": {
      "type": "object",
      "properties": {
        "id": {
          "type": "string"
        },
        "email": {
          "type": "string"
        },
        "isEmailVerified": {
          "type": "boolean",
          "format": "boolean"
        },
        "sequence": {
          "type": "string",
          "format": "uint64"
        },
        "creation_date": {
          "type": "string",
          "format": "date-time"
        },
        "change_date": {
          "type": "string",
          "format": "date-time"
        }
      }
    },
    "v1UserGrantSearchKey": {
      "type": "string",
      "enum": [
        "UserGrantSearchKey_UNKNOWN",
        "UserGrantSearchKey_ORG_ID",
        "UserGrantSearchKey_PROJECT_ID"
      ],
      "default": "UserGrantSearchKey_UNKNOWN"
    },
    "v1UserGrantSearchQuery": {
      "type": "object",
      "properties": {
        "key": {
          "$ref": "#/definitions/v1UserGrantSearchKey"
        },
        "method": {
          "$ref": "#/definitions/v1SearchMethod"
        },
        "value": {
          "type": "string"
        }
      }
    },
    "v1UserGrantSearchRequest": {
      "type": "object",
      "properties": {
        "offset": {
          "type": "string",
          "format": "uint64"
        },
        "limit": {
          "type": "string",
          "format": "uint64"
        },
        "sorting_column": {
          "$ref": "#/definitions/v1UserGrantSearchKey"
        },
        "asc": {
          "type": "boolean",
          "format": "boolean"
        },
        "queries": {
          "type": "array",
          "items": {
            "$ref": "#/definitions/v1UserGrantSearchQuery"
          }
        }
      }
    },
    "v1UserGrantSearchResponse": {
      "type": "object",
      "properties": {
        "offset": {
          "type": "string",
          "format": "uint64"
        },
        "limit": {
          "type": "string",
          "format": "uint64"
        },
        "total_result": {
          "type": "string",
          "format": "uint64"
        },
        "result": {
          "type": "array",
          "items": {
            "$ref": "#/definitions/v1UserGrantView"
          }
        }
      }
    },
    "v1UserGrantView": {
      "type": "object",
      "properties": {
        "OrgId": {
          "type": "string"
        },
        "ProjectId": {
          "type": "string"
        },
        "UserId": {
          "type": "string"
        },
        "Roles": {
          "type": "array",
          "items": {
            "type": "string"
          }
        },
        "OrgName": {
          "type": "string"
        }
      }
    },
    "v1UserPhone": {
      "type": "object",
      "properties": {
        "id": {
          "type": "string"
        },
        "phone": {
          "type": "string"
        },
        "is_phone_verified": {
          "type": "boolean",
          "format": "boolean"
        },
        "sequence": {
          "type": "string",
          "format": "uint64"
        },
        "creation_date": {
          "type": "string",
          "format": "date-time"
        },
        "change_date": {
          "type": "string",
          "format": "date-time"
        }
      }
    },
    "v1UserProfile": {
      "type": "object",
      "properties": {
        "id": {
          "type": "string"
        },
        "user_name": {
          "type": "string"
        },
        "first_name": {
          "type": "string"
        },
        "last_name": {
          "type": "string"
        },
        "nick_name": {
          "type": "string"
        },
        "display_name": {
          "type": "string"
        },
        "preferred_language": {
          "type": "string"
        },
        "gender": {
          "$ref": "#/definitions/v1Gender"
        },
        "sequence": {
          "type": "string",
          "format": "uint64"
        },
        "creation_date": {
          "type": "string",
          "format": "date-time"
        },
        "change_date": {
          "type": "string",
          "format": "date-time"
        }
      }
    },
    "v1UserSessionState": {
      "type": "string",
      "enum": [
        "USERSESSIONSTATE_UNSPECIFIED",
        "USERSESSIONSTATE_ACTIVE",
        "USERSESSIONSTATE_TERMINATED"
      ],
      "default": "USERSESSIONSTATE_UNSPECIFIED"
    },
    "v1UserSessionView": {
      "type": "object",
      "properties": {
        "id": {
          "type": "string"
        },
        "agent_id": {
          "type": "string"
        },
        "auth_state": {
          "$ref": "#/definitions/v1UserSessionState"
        },
        "user_id": {
          "type": "string"
        },
        "user_name": {
          "type": "string"
        },
        "sequence": {
          "type": "string",
          "format": "uint64"
        }
      }
    },
    "v1UserSessionViews": {
      "type": "object",
      "properties": {
        "user_sessions": {
          "type": "array",
          "items": {
            "$ref": "#/definitions/v1UserSessionView"
          }
        }
      }
    },
    "v1VerifyMfaOtp": {
      "type": "object",
      "properties": {
        "code": {
          "type": "string"
        }
      }
    },
    "v1VerifyMyUserEmailRequest": {
      "type": "object",
      "properties": {
        "code": {
          "type": "string"
        }
      }
    },
    "v1VerifyUserPhoneRequest": {
      "type": "object",
      "properties": {
        "code": {
          "type": "string"
        }
      }
    }
  }
}