post/oauth2/applications/{id}/client-secret/reset

Reset client secret

Rotates the client secret for an OAuth2 application. Requires sudo mode authentication. Essential security operation for protecting client credentials. Existing access tokens remain valid.

reset_client_secret

Parameters

Name	In	Type	Description
id*	path	SnowflakeType	The ID of the application

Request body

application/json

json

{
  "type": "object",
  "properties": {
    "password": {
      "description": "Account password for sudo verification",
      "$ref": "#/components/schemas/PasswordType"
    },
    "mfa_method": {
      "description": "MFA method to use for verification",
      "x-enumNames": [
        "TOTP",
        "WebAuthn"
      ],
      "x-enumDescriptions": [
        "Time-based one-time password authentication via authenticator app",
        "Security key or biometric authentication"
      ],
      "enum": [
        "totp",
        "webauthn"
      ],
      "type": "string"
    },
    "mfa_code": {
      "description": "MFA verification code from an authenticator app",
      "type": "string"
    },
    "webauthn_response": {
      "description": "WebAuthn authentication response",
      "$ref": "#/components/schemas/WebAuthnAuthenticationResponse"
    },
    "webauthn_challenge": {
      "description": "WebAuthn challenge string",
      "type": "string"
    }
  }
}

Responses

200

Success

json

{
  "type": "object",
  "properties": {
    "id": {
      "description": "The unique identifier of the application",
      "$ref": "#/components/schemas/SnowflakeStringType"
    },
    "name": {
      "type": "string",
      "description": "The name of the application"
    },
    "redirect_uris": {
      "maxItems": 10,
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "The registered redirect URIs for OAuth2"
    },
    "bot_public": {
      "type": "boolean",
      "description": "Whether the bot can be invited by anyone"
    },
    "bot_require_code_grant": {
      "type": "boolean",
      "description": "Whether the bot requires OAuth2 code grant"
    },
    "client_secret": {
      "description": "The client secret for OAuth2 authentication",
      "type": "string"
    },
    "bot": {
      "description": "The bot user associated with the application",
      "type": "object",
      "properties": {
        "id": {
          "description": "The unique identifier of the bot user",
          "$ref": "#/components/schemas/SnowflakeStringType"
        },
        "username": {
          "type": "string",
          "description": "The username of the bot"
        },
        "discriminator": {
          "type": "string",
          "description": "The discriminator of the bot"
        },
        "avatar": {
          "description": "The avatar hash of the bot",
          "type": [
            "string",
            "null"
          ]
        },
        "banner": {
          "description": "The banner hash of the bot",
          "type": [
            "string",
            "null"
          ]
        },
        "bio": {
          "description": "The bio or description of the bot",
          "type": [
            "string",
            "null"
          ]
        },
        "token": {
          "description": "The bot token for authentication",
          "type": "string"
        },
        "mfa_enabled": {
          "description": "Whether the bot has MFA enabled",
          "type": "boolean"
        },
        "authenticator_types": {
          "description": "The types of authenticators enabled",
          "maxItems": 10,
          "type": "array",
          "items": {
            "$ref": "#/components/schemas/AuthenticatorType"
          }
        },
        "flags": {
          "$ref": "#/components/schemas/BotFlags"
        }
      },
      "required": [
        "id",
        "username",
        "discriminator",
        "bio",
        "flags"
      ],
      "additionalProperties": false
    }
  },
  "required": [
    "id",
    "name",
    "redirect_uris",
    "bot_public",
    "bot_require_code_grant"
  ],
  "additionalProperties": false
}

400

Bad Request - The request was malformed or contained invalid data

json

{
  "type": "object",
  "properties": {
    "code": {
      "type": "string",
      "description": "Machine-readable error code"
    },
    "message": {
      "type": "string",
      "description": "Human-readable error message"
    },
    "errors": {
      "description": "Field-specific validation errors",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "path": {
            "type": "string",
            "description": "Field path that failed validation"
          },
          "code": {
            "description": "Machine-readable validation error code",
            "type": "string"
          },
          "message": {
            "type": "string",
            "description": "Human-readable validation error message"
          }
        },
        "required": [
          "path",
          "message"
        ],
        "additionalProperties": false
      }
    }
  },
  "required": [
    "code",
    "message"
  ],
  "additionalProperties": {}
}

401

Unauthorized - Authentication is required or the token is invalid

json

{
  "type": "object",
  "properties": {
    "code": {
      "type": "string",
      "description": "Machine-readable error code"
    },
    "message": {
      "type": "string",
      "description": "Human-readable error message"
    },
    "errors": {
      "description": "Field-specific validation errors",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "path": {
            "type": "string",
            "description": "Field path that failed validation"
          },
          "code": {
            "description": "Machine-readable validation error code",
            "type": "string"
          },
          "message": {
            "type": "string",
            "description": "Human-readable validation error message"
          }
        },
        "required": [
          "path",
          "message"
        ],
        "additionalProperties": false
      }
    }
  },
  "required": [
    "code",
    "message"
  ],
  "additionalProperties": {}
}

403

Forbidden - You do not have permission to perform this action

json

{
  "type": "object",
  "properties": {
    "code": {
      "type": "string",
      "description": "Machine-readable error code"
    },
    "message": {
      "type": "string",
      "description": "Human-readable error message"
    },
    "errors": {
      "description": "Field-specific validation errors",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "path": {
            "type": "string",
            "description": "Field path that failed validation"
          },
          "code": {
            "description": "Machine-readable validation error code",
            "type": "string"
          },
          "message": {
            "type": "string",
            "description": "Human-readable validation error message"
          }
        },
        "required": [
          "path",
          "message"
        ],
        "additionalProperties": false
      }
    }
  },
  "required": [
    "code",
    "message"
  ],
  "additionalProperties": {}
}

429

Too Many Requests - You are being rate limited

json

{
  "type": "object",
  "properties": {
    "code": {
      "type": "string",
      "description": "Machine-readable error code"
    },
    "message": {
      "type": "string",
      "description": "Human-readable error message"
    },
    "errors": {
      "description": "Field-specific validation errors",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "path": {
            "type": "string",
            "description": "Field path that failed validation"
          },
          "code": {
            "description": "Machine-readable validation error code",
            "type": "string"
          },
          "message": {
            "type": "string",
            "description": "Human-readable validation error message"
          }
        },
        "required": [
          "path",
          "message"
        ],
        "additionalProperties": false
      }
    },
    "retry_after": {
      "type": "number",
      "description": "Seconds to wait before retrying"
    },
    "global": {
      "type": "boolean",
      "description": "Whether this is a global rate limit"
    }
  },
  "required": [
    "code",
    "message"
  ],
  "additionalProperties": {}
}

500

Internal Server Error - An unexpected error occurred

json

{
  "type": "object",
  "properties": {
    "code": {
      "type": "string",
      "description": "Machine-readable error code"
    },
    "message": {
      "type": "string",
      "description": "Human-readable error message"
    },
    "errors": {
      "description": "Field-specific validation errors",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "path": {
            "type": "string",
            "description": "Field path that failed validation"
          },
          "code": {
            "description": "Machine-readable validation error code",
            "type": "string"
          },
          "message": {
            "type": "string",
            "description": "Human-readable validation error message"
          }
        },
        "required": [
          "path",
          "message"
        ],
        "additionalProperties": false
      }
    }
  },
  "required": [
    "code",
    "message"
  ],
  "additionalProperties": {}
}