v1

latestOpenAPI 3.1.02026-07-246652306.5 KB

getAuthCode

Use to send a user to the Sonos login service, for example, with a button instructing the user to enable your integration to use Sonos that sends the user to your redirect URI.

get/login/v3/oauth

Query parameters

client_idstring required

Your app key

response_typestring required

Value must be "code", for Sonos to send your authorization code.

statestring required

An opaque value used by the client to maintain state between the request and callback. We recommend that you randomly generate this and check it with the state value Sonos sends back in the response to make sure no cross site forgery happened. See the OAuth 2.0 RFC for details.

scopestring required

The scope of the access request. Currently, there is only one scope: playback-control-all.

redirect_uristring

URI of site to receive the redirect call with the authorization code. This must match one of the redirect URIs that you provided in the integration manager when you got your client credentials. This must also be URL encoded.

Response

200

object required

All 66 operations