Sha256: d608096a7826184f6ddf640b583922f01e09f639cbe5a3b567c06e2629b705e7

Contents?: true

Size: 1.49 KB

Versions: 3

Compression:

Stored size: 1.49 KB

Contents

<%= "# Individual Permissions are not implemented in this application" if ::Opro.request_permissions.blank? %>


# Permissions

Permissions give the user a way to control the scope of access that a client application has to their data. This is similar to how Facebook will ask users what actions an application can take on their behalf.


<% if ::Opro.request_permissions.present? && ::Opro.request_permissions.map(&:to_s).include?("write") %>

## Write Access

To perform any type of request other than a [GET](http://en.wikipedia.org/wiki/Hypertext_Transfer_Protocol#Request_methods) request, your application must have `write` access from the user. Your application can request this permission with `scope` (see Request Scope below). By default all permissions will be requested.

<% end %>

## Request Scope

As a client application, you can request specific scopes while you are authorizing a user. If no scope is specified, all permissions will be requested. This is an example of an application with client id of `3234myClientId5678` specifying that they want `write` access for their app:


    <%= oauth_authorize_url(:client_id => "3234myClientId5678", :protocol => @protocol) + "&scope[]=write" %>


While authorizing your application a user can choose to grant or reject individual permissions.


## Available Permissions/Scopes

These are the available permissions you can request as a client application. If no scope is provided, all permissions will be requested.

      <%= ::Opro.request_permissions.inspect %>

Version data entries

3 entries across 3 versions & 1 rubygems

Version Path
opro-0.4.3 app/views/opro/oauth/docs/markdown/permissions.md.erb
opro-0.4.2 app/views/opro/oauth/docs/markdown/permissions.md.erb
opro-0.4.1 app/views/opro/oauth/docs/markdown/permissions.md.erb