penicillin/blue.starry.penicillin.endpoints.account/verifyCredentials

verifyCredentials

fun Account.verifyCredentials(    includeEntities: Boolean? = null,     skipStatus: Boolean? = null,     includeEmail: Boolean? = null,     vararg options: Option): JsonObjectApiAction<Account.VerifyCredentials>
Content copied to clipboard

Returns an HTTP 200 OK response code and a representation of the requesting user if authentication was successful; returns a 401 status code and an error message if not. Use this method to test if supplied user credentials are valid.

Twitter API reference

Receiver

Account endpoint instance.

Return

JsonObjectApiAction for VerifyCredentials model.

Parameters

includeEntities

Optional. The entities node will not be included when set to false.

skipStatus

Optional. When set to either true, t or 1 statuses will not be included in the returned user object.

includeEmail

Optional. When set to true email will be returned in the user objects as a string. If the user does not have an email address on their account, or if the email address is not verified, null will be returned.

options

Optional. Custom parameters of this request.


val Account.verifyCredentials: JsonObjectApiAction<Account.VerifyCredentials>
Content copied to clipboard

Shorthand property to Account.verifyCredentials.

See also