PingOne

Editing an API service

You can edit API service settings, operations, and rules. You can also configure scopes and access tokens in basic rules.

Steps

  1. Go to Authorization > API Services, click the More Options (⋮) icon next to the API service that you want to edit, and select Edit.

  2. Update any of the following settings:

    1. Optional: Change the API service Name or Base URLs.

    2. To change the PingOne Resource associated with the API service, select a resource from the list, or select the option to Automatically create a PingOne Resource.

      This resource is managed by the API service and there are restrictions against deleting the resource while it’s associated with an API service. Resources created automatically will have the same name as the API service. For more information about resources, see API services.

    3. Click Save.

  3. To add an operation, click the Operations tab, and then click Define Operation. Complete settings to define the operation.

  4. To edit an operation, click the Operations tab, click the More Options (⋮) icon next to the operation name, and then select Edit Operation:

    1. Optional: Change Methods, Paths, or the operation Name.

    2. Optional: In Access Rules, change the Groups that are granted access to the operation, or the scopes that must be authorized.

      Screen capture showing the groups and scopes basic access rules.

    3. Click Save.

  5. To edit the API service’s authorized scopes, on the Advanced tab, click the Pencil icon.

    Scopes determine the resources that a client can access.

    The Advanced tab is not available when user directory services and access token validation are managed externally. In this case, use your external provider, such as PingFederate, to configure authorized scopes.

    1. Optional: Change a scope Name or Description.

    2. To add a scope, click +Add, and then enter a Name and Description for the scope.

    3. To remove a scope, click the Delete icon next to the description.

    4. Click Save.

  6. To configure the access token for the API service:

    1. On the Advanced tab, click Configure Access Token.

    2. Edit the scopes assigned to the resource.

      For more information, see Editing a resource.

    3. Click Save.

  7. To edit custom policies for the API service:

    1. Go to Authorization → Policies and select the policy in the API Access Management policy tree.

      You can edit any of the policies that are nested under Custom policy sets.

    2. Update the policy, and then click Save changes.

    3. Go to Authorization → API Services and select the API service.

    4. Click Deploy.