{"_id":"56acebfb13ac890d001c3c8a","parentDoc":null,"project":"56acd71213ac890d001c3c7a","category":{"_id":"56acd93a13ac890d001c3c82","__v":4,"pages":["56acdb1c13ac890d001c3c83","56ace30c5ac4060d00278664","56ace4611c09150d00a18379","56acebfb13ac890d001c3c8a"],"project":"56acd71213ac890d001c3c7a","version":"56acd71213ac890d001c3c7d","sync":{"url":"","isSync":false},"reference":false,"createdAt":"2016-01-30T15:39:38.798Z","from_sync":false,"order":1,"slug":"authorization","title":"Authorization"},"__v":8,"githubsync":"","version":{"_id":"56acd71213ac890d001c3c7d","project":"56acd71213ac890d001c3c7a","__v":15,"createdAt":"2016-01-30T15:30:26.928Z","releaseDate":"2016-01-30T15:30:26.928Z","categories":["56acd71313ac890d001c3c7e","56acd8f113ac890d001c3c81","56acd8f95ac4060d0027865e","56acd93a13ac890d001c3c82","56ad20660ab3c00d00ce3347","56ad356a2a7860170013f714","56ad47eb0ab3c00d00ce334f","56afd523bc304a0d00ace1df","56b29a019621f20d00efb37e","56b657e11bc6970d009feee7","5845cc3c39950c1b002afe77","5845cde163c11b250037967e","5846efd45d064323007b17b4","588604da4674e32300efd160","588627882393d50f00f1322c"],"is_deprecated":false,"is_hidden":false,"is_beta":false,"is_stable":true,"codename":"","version_clean":"1.0.0","version":"1.0"},"user":"56acd6caa040860d00ac94a2","updates":[],"next":{"pages":[],"description":""},"createdAt":"2016-01-30T16:59:39.519Z","link_external":false,"link_url":"","sync_unique":"","hidden":false,"api":{"results":{"codes":[]},"settings":"","auth":"required","params":[],"url":""},"isReference":false,"order":3,"body":"[block:callout]\n{\n  \"type\": \"info\",\n  \"title\": \"Requiring multiple scopes\",\n  \"body\": \"If you require multiple scopes, request them using a comma separator during authorization URL generation. E.g., 'read_only,subscriber_read_full'\"\n}\n[/block]\n\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Scope\",\n    \"h-1\": \"Description\",\n    \"0-0\": \"read_only\",\n    \"0-1\": \"**Use this when you're building applications that you intend for GameWisp channels to use. **Provides access to the Channel Resource.\\n\\nProvides read only access to basic channel information, a channel's subscribers, and their tiers and benefits.\\n\\nThis is the default scope. If no scope is passed to the endpoint, this scope is assumed.\",\n    \"1-0\": \"subscriber_read_full\",\n    \"1-1\": \"**Use this when you're building applications that you want GameWisp subscribers to use. **Provides access to the subscription endpoint in the User Resource.\\n\\nAllows access to endpoints that return full subscriber information, including user input on benefit data. Don't request this scope from a subscriber unless you absolutely need that information from subscribers.\\n\\nUseful if you want to build applications for GameWisp subscribers and do not necessarily have authorization for a channel to which a subscriber is subscribed.\",\n    \"2-0\": \"user_read\",\n    \"2-1\": \"**Use this when you're building applications that require user information: avatars, About Me, etc.**\\n\\nAllows access to the information endpoint in the User Resource. Since this scope allows access to basic user information,  it's usually good practice to request this scope along with whatever others you may need.\"\n  },\n  \"cols\": 2,\n  \"rows\": 3\n}\n[/block]","excerpt":"Both Singularity and the RESTful API depend on scopes for access restriction.","slug":"scopes","type":"basic","title":"Scopes"}

Scopes

Both Singularity and the RESTful API depend on scopes for access restriction.

[block:callout] { "type": "info", "title": "Requiring multiple scopes", "body": "If you require multiple scopes, request them using a comma separator during authorization URL generation. E.g., 'read_only,subscriber_read_full'" } [/block] [block:parameters] { "data": { "h-0": "Scope", "h-1": "Description", "0-0": "read_only", "0-1": "**Use this when you're building applications that you intend for GameWisp channels to use. **Provides access to the Channel Resource.\n\nProvides read only access to basic channel information, a channel's subscribers, and their tiers and benefits.\n\nThis is the default scope. If no scope is passed to the endpoint, this scope is assumed.", "1-0": "subscriber_read_full", "1-1": "**Use this when you're building applications that you want GameWisp subscribers to use. **Provides access to the subscription endpoint in the User Resource.\n\nAllows access to endpoints that return full subscriber information, including user input on benefit data. Don't request this scope from a subscriber unless you absolutely need that information from subscribers.\n\nUseful if you want to build applications for GameWisp subscribers and do not necessarily have authorization for a channel to which a subscriber is subscribed.", "2-0": "user_read", "2-1": "**Use this when you're building applications that require user information: avatars, About Me, etc.**\n\nAllows access to the information endpoint in the User Resource. Since this scope allows access to basic user information, it's usually good practice to request this scope along with whatever others you may need." }, "cols": 2, "rows": 3 } [/block]