Managing Resources

Warning: Pivotal Single Sign-On v1.11 is no longer supported because it has reached the End of General Support (EOGS) phase as defined by the Support Lifecycle Policy. To stay up to date with the latest software and security updates, upgrade to a supported version.

This topic describes how a Space Developer defines resources required by an app bound to a Pivotal Single Sign‑On service instance and how an administrator grants resource permissions.

In this topic, resources are the API endpoints that users and apps need to retrieve information from a resource server. After an administrator creates resources, they assign the resources to users and apps. Users can then grant apps access to the resources, for example to query API endpoints on their behalf.

Because developers know what endpoints exist for their apps, they are responsible for creating resources.

Create or Edit Resources

If an app requires access to specific resources such as API endpoints, permissions for those resources must be either bootstrapped from the app manifest or defined by the Space Developer in the SSO Developer Dashboard.

To bootstrap resources from the manifest, follow the instructions in the Single Sign‑On Sample Applications repository.

To create resources in the SSO Developer Dashboard, do the following:

  1. Log in to Apps Manager as a Space Developer.

  2. Select the space where your service instance is located.

  3. Under Services, click Manage next to your Single Sign‑On service instance to launch the SSO Developer Dashboard. Sso dev dashboard resources View a larger version of this image.

  4. Click the Resources tab.

  5. Click Create Resource.

  6. Enter a Resource Name.

  7. Create Permissions that the OAuth client for your app needs to access from the resource server.

    1. Enter one or more attributes or actions for each permission.
    2. Enter a Description for each permission.
  8. Click Create Resource.

  9. An administrator can map existing groups to the created resource. For more information, see Create or Edit Resource Permissions Mapping.

Note: Space Developers create resources within a space. Space Developers only see the resources created in the spaces they have access to and can only assign those to the apps in those spaces.

Delete Resources

  1. Log in to Apps Manager as a Space Developer.

  2. Click the Manage link under the Single Sign‑On service instance to launch the SSO Developer Dashboard. Sso dev dashboard resources View a larger version of this image.

  3. Click the Resources tab.

  4. Click the resource to delete.

  5. Click Delete Resource at the bottom of the page.

  6. On the popup, click Delete Resource to delete the resource.

Note: Deleting a resource removes it from the permission mappings and from the app. You must reconfigure the updated permissions in both areas.

About Space Protection for Resources

OAuth 2.0 provides the concept of a scope in order to limit the amount of access that is granted to an access token. A scope is the intersection of a user’s groups and a client’s scopes.

For a user to gain access to a resource, they must meet the following conditions, which can only be set up by plan administrators:

  • The user must be assigned the resource as a group. For information on how to do this, see Manage Users.
  • The user must access an app that has the resource assigned as a scope.

App developers can assign scopes to any app that is not a service-to-service app. But, only plan administrators can assign scopes to users.

When assigning a resource as a scope for a service-to-service app, app developers can only assign resources they have created within their own space. Only a plan administrator can assign a scope from another space to a service-to-service app.