SpotifyScope

enum SpotifyScope : Enum<SpotifyScope>

Scopes provide Spotify users using third-party apps the confidence that only the information they choose to share will be shared, and nothing more.

Each represents a distinct privilege and may be required by one or more endpoints as discussed on the Spotify Authorization Documentation

Parameters

uri

The scope id

Entries

APP_REMOTE_CONTROL
Link copied to clipboard
common
APP_REMOTE_CONTROL("app-remote-control")
Remote control playback of Spotify.
PLAYLIST_READ_PRIVATE
Link copied to clipboard
common
PLAYLIST_READ_PRIVATE("playlist-read-private")
Read access to user's private playlists.
PLAYLIST_READ_COLLABORATIVE
Link copied to clipboard
common
PLAYLIST_READ_COLLABORATIVE("playlist-read-collaborative")
Include collaborative playlists when requesting a user's playlists.
PLAYLIST_MODIFY_PUBLIC
Link copied to clipboard
common
PLAYLIST_MODIFY_PUBLIC("playlist-modify-public")
Write access to a user's public playlists.
PLAYLIST_MODIFY_PRIVATE
Link copied to clipboard
common
PLAYLIST_MODIFY_PRIVATE("playlist-modify-private")
Write access to a user's private playlists.
STREAMING
Link copied to clipboard
common
STREAMING("streaming")
Control playback of a Spotify track.
UGC_IMAGE_UPLOAD
Link copied to clipboard
common
UGC_IMAGE_UPLOAD("ugc-image-upload")
Let the application upload playlist covers and profile imagesVisible to users: Upload images to personalize your profile or playlist cover
USER_FOLLOW_MODIFY
Link copied to clipboard
common
USER_FOLLOW_MODIFY("user-follow-modify")
Write/delete access to the list of artists and other users that the user follows.
USER_FOLLOW_READ
Link copied to clipboard
common
USER_FOLLOW_READ("user-follow-read")
Read access to the list of artists and other users that the user follows.
USER_LIBRARY_READ
Link copied to clipboard
common
USER_LIBRARY_READ("user-library-read")
Read access to a user's "Your Music" library.
USER_LIBRARY_MODIFY
Link copied to clipboard
common
USER_LIBRARY_MODIFY("user-library-modify")
Write/delete access to a user's "Your Music" library.
USER_MODIFY_PLAYBACK_STATE
Link copied to clipboard
common
USER_MODIFY_PLAYBACK_STATE("user-modify-playback-state")
Write access to a user’s playback stateVisible to users: Control playback on your Spotify clients and Spotify Connect devices.
USER_READ_PRIVATE
Link copied to clipboard
common
USER_READ_PRIVATE("user-read-private")
Read access to user’s subscription details (type of user account).
USER_READ_EMAIL
Link copied to clipboard
common
USER_READ_EMAIL("user-read-email")
Read access to user’s email address.
USER_TOP_READ
Link copied to clipboard
common
USER_TOP_READ("user-top-read")
Read access to a user's top artists and tracks.
USER_READ_PLAYBACK_STATE
Link copied to clipboard
common
USER_READ_PLAYBACK_STATE("user-read-playback-state")
Read access to a user’s player state.
USER_READ_PLAYBACK_POSITION
Link copied to clipboard
common
USER_READ_PLAYBACK_POSITION("user-read-playback-position")
Read access to a user’s playback position in a content.
USER_READ_CURRENTLY_PLAYING
Link copied to clipboard
common
USER_READ_CURRENTLY_PLAYING("user-read-currently-playing")
Read access to a user’s currently playing trackVisible to users: Read your currently playing track
USER_READ_RECENTLY_PLAYED
Link copied to clipboard
common
USER_READ_RECENTLY_PLAYED("user-read-recently-played")
Read access to a user’s recently played tracks.

Properties

name
Link copied to clipboard
common
val name: String
ordinal
Link copied to clipboard
common
val ordinal: Int
uri
Link copied to clipboard
common
val uri: String
The scope id

Sources

common source
Link copied to clipboard