Skip to content

Latest commit

 

History

History
680 lines (500 loc) · 25.5 KB

cloud-foundry-uaa-server-5e4e03c.md

File metadata and controls

680 lines (500 loc) · 25.5 KB

Cloud Foundry UAA Server

Follow this procedure to set up the Cloud Foundry UAA server as а proxy system.

Prerequisites

Restriction:

This system is available for standalone tenants running on SAP Cloud Identity infrastructure and SAP BTP, Neo environment. Bundle tenants running on SAP Cloud Identity Services infrastructure and Neo environment can use it only through SAP Jam Collaboration and SAP Identity Access Governance bundle options.

  • You have a technical user with administrator permissions for Cloud Foundry UAA to read, create, and update user account information. You need Cloud Foundry UAA version 4.2 or higher.
  • (Optional) You have installed the Cloud Connector in your corporate environment and have done the initial configuration. You need to do this only if the Cloud Foundry UAA server is exposed in a private corporate network. For more information, see Cloud Connector.

Note:

Administrators of bundle tenants on Neo environment should enable the Manage OAuth Clients permission, as described in Neo Environment section in Manage Authorizations ↗️.

Context

User Account and Authentication Service (UAA) is an OAuth2 server that you can use for centralized identity management. It owns the user accounts and authentication sources, and supports standard protocols (such as SAML, LDAP, and OpenID Connect) to provide SSO and delegated authorization to Web applications. For more information, see Cloud Foundry UAA: Overview.

Cloud Foundry UAA is responsible for the SAP ID service to create and manage platform users (platform administrators and platform developers) in Cloud Foundry.

Tip:

This connector is meant for provisioning users and groups from/to general Cloud Foundry systems (they could be non-SAP ones). If you want to trigger provisioning of entities from/to SAP Business Technology Platform Cloud Foundry applications, you'd better use SAP BTP XS Advanced UAA (Cloud Foundry) proxy system.

These proxy systems consume SCIM 1.1 API provided by Cloud Foundry UAA.

Remember:

You can manage users and groups to Cloud Foundry on application level only. You cannot manage them on a subaccount level.

Note:

The Identity Provisioning implementation of the Proxy System SCIM API (based on the SCIM Query) supports single entity and delta read filtering for users and groups. For more information, see Query Parameters for Proxy System SCIM API.

Follow the steps below to create a SCIM 2.0 representation of your proxy Cloud Foundry UAA system. You can then provision on demand new users and groups back to Cloud Foundry UAA.

Procedure

  1. (Optional) Open Cloud Connector to add an access control system mapping for the Cloud Foundry UAA Server. This is needed to allow the Identity Provisioning service to access the Cloud Foundry UAA system as a back-end system on the intranet. To learn how, see: Configure Access Control (HTTP)

  2. Open your subaccount in SAP BTP cockpit (valid for OAuth authentication to the Identity Provisioning proxy system).

    Note:

    If you have a bundle tenant, then in the cockpit → Neo → Overview, you can see the Global account, which SAP provides for your bundle in the corresponding Identity Provisioning region. Then, in the global account, you can see your subaccount, where the Identity Provisioning is enabled as a service for the bundle. The display name of the subaccount starts with SAP_BUNDLE.

  3. Sign in to the administration console of SAP Cloud Identity Services and navigate to Users & Authorizations > Administrators.

  4. Create a technical user with the necessary authorizations. It will later be used by the external consumer to connect to Identity Provisioning.

    • For Certificate-based authentication, follow the procedure in Manage Certificates for Inbound Connection → SAP BTP, Neo Environment

    • For OAuth authentication, proceed as follows:

      1. Go to Security > OAuth > Clients and choose Register New Client.

      2. From the Subscription combo box, select <provider_subaccount>/ipsproxy.

      3. From the Authorization Grant combo box, select Client Credentials.

      4. In the Secret field, enter a password (client secret) and remember it. You will need it later, for the repository configuration in the external system.

      5. Copy/paste and save (in a notepad) the generated Client ID. You will need it later, too.

      6. From the left-side navigation, choose Subscriptions > Java Applications > ipsproxy .

      7. From the left-side navigation, choose Roles > IPS_PROXY_USER.

      8. Choose Assign and enter oauth_client_<client_ID>.

        For <client_ID>, enter the one you have saved in the previous main step.

    • For Certificate-based authentication, upload the certificate for the technical user of type System, as described in Add System as Administrator and enable the Access Proxy System API permission.

    • For Basic authentication, proceed as follows:

      1. Add an administrator user of type System and configure the basic authentication method for this user.

        If you already have a technical user, skip this step.

      2. Save your changes.

      3. Select your administrator user of type System and enable the Access Proxy System API permission.

      4. Save your changes.

  5. Access the Identity Provisioning UI.

  6. Add Cloud Foundry UAA Server as a proxy system. For more information, see Add New Systems.

  7. Choose the Properties tab to configure the connection settings for your system.

    Note:

    If your tenant is running on SAP BTP, Neo environment, you can create a connectivity destination in your subaccount in the SAP BTP cockpit, and then select it from the Destination Name combo box in your Identity Provisioning User Interface.

    If one and the same property exists both in the cockpit and in the Properties tab, the value set in the Properties tab is considered with higher priority.

    We recommend that you use the Properties tab. Use a connectivity destination only if you need to reuse one and the same configuration for multiple provisioning systems.

    Mandatory Properties

    Property Name

    Description & Value

    Type

    Enter: HTTP

    URL

    Specify the URL to the Cloud Foundry UAA SCIM API.

    If not sure about the exact URL, ask your Cloud Foundry UAA administrator.

    ProxyType

    Enter: Internet

    Authentication

    Enter: BasicAuthentication

    OAuth2TokenServiceURL

    As you need to make OAuth authentication to the UAA system, enter the URL to the OAuth2 token service.

    If not sure about the exact URL, ask your Cloud Foundry UAA administrator.

    User

    Enter the OAuth client ID of the Cloud Foundry UAA technical user.

    Password

    (Credential) Enter the OAuth client secret of the technical user.

    uaa.origin

    Enter the location of your Cloud Foundry identity provider. If not sure about the value, ask your Cloud Foundry UAA administrator.

    The value of this property is a string, which will be used as the origin attribute in the system transformations.

    uaa.origin.filter.enabled

    This flag property depends on uaa.origin. Possible values: true or false

    • If set to true, the Identity Provisioning service will read only users whose identity provider is set as a value of uaa.origin.
    • If set to false, the Identity Provisioning service will read all users, regardless of their origin.
    • If set to true but the uaa.origin property is missing, the provisioning will fail.

    scim.support.patch.operation

    Use this property if you want to modify the members of a group.

    Possible values:

    • true – the Identity Provisioning service will modify the group membership via the PATCH /Groups endpoint of UAA. To learn how, see Patch
    • false – the Identity Provisioning service will modify the group membership via the POST /Groups or DELETE /Groups endpoints of UAA. To learn how, see Add Member and Remove Member.

    uaa.patch.response.with.resource

    Use this property if you want to retrieve a group whose membership was modified.

    Note:

    This property is usable only when you have configured membership modifications via Add/Remove Member UAA endpoints. That is, when the scim.support.patch.operation property is set to false.

    Possible values:

    • true – the Identity Provisioning service will return the modified group via the GET /Groups endpoint of UAA. To learn how, see Retrieve.
    • false – no modified groups will be returned by the service.

    To learn what additional properties are relevant to this system, see List of Properties. You can use the main search, or filter properties by the Name or System Type columns.

    Exemplary destination:

    Type=HTTP

    Authentication=BasicAuthentication

    ProxyType=Internet

    URL=https://api.authentication.hana.ondemand.com

    OAuth2TokenServiceURL=https://MyCFaccount.authentication.hana.ondemand.com/oauth/token

    User=MyCFuser

    Password=************

    uaa.origin=my_UAA_location

    uaa.origin.filter.enabled=true

    scim.support.patch.operation=true

    uaa.patch.response.with.resource=false

  8. (Optional) Configure the transformations.

    Transformations are used to map the user attributes from the data model of the source system to the data model of the target system, and the other way around. The Identity Provisioning offers a default transformation for the Cloud Foundry UAA Server proxy system, whose settings are displayed under the Transformations tab after saving its initial configuration.

    You can change the default transformation mapping rules to reflect your current setup of entities in your Cloud Foundry UAA server. For more information, see:

    Manage Transformations

    Cloud Foundry UAA API: Users

    Cloud Foundry UAA API: Groups

    Default read and write transformations:

    Tip:

    The proxy Read Transformation is used when the external client application (for example, SAP Identity Management) makes initial load. That is, executing GET requests to the resource endpoints (/Users or /Groups) to retrieve the corresponding entities of the particular type. The external client application can also execute GET requests to a single resource endpoint (querying a single resource is supported). In this case, the proxy system acts as a source one.

    The proxy Write Transformation is used when the external application manages the entities in the proxy system – creates new entities, updates existing ones, or deletes existing ones. In this case, the proxy system acts as a target one.

    However, after a Create or Update operation is performed on the proxy system, the Read Transformation is applied to the result, so that the created or updated entity is sent back to the external application. This behavior demonstrates that the proxy Read Transformation is used for write cases, as well.

    Read Transformation

    Write Transformation

    Code Syntax:

    {
  "user": {
    "mappings": [
      {
        "sourcePath": "$.id",
        "targetPath": "$.id",
        "targetVariable": "entityIdSourceSystem"
      },
      {
        "sourceVariable": "entityBaseLocation",
        "targetPath": "$.meta.location",
        "targetVariable": "entityLocationSourceSystem",
        "functions": [
          {
            "type": "concatString",
            "suffix": "${entityIdSourceSystem}"
          }
        ]
      },
      {
        "sourcePath": "$.userName",
        "targetPath": "$.userName",
        "correlationAttribute": true
      },
      {
        "sourcePath": "$.name",
        "targetPath": "$.name",
        "optional": true
      },
      {
        "sourcePath": "$.emails",
        "targetPath": "$.emails",
        "preserveArrayWithSingleElement": true
      },
      {
        "sourcePath": "$.emails[?(@.primary== true)].value",
        "correlationAttribute": true
      },
      {
        "sourcePath": "$.groups",
        "targetPath": "$.groups",
        "preserveArrayWithSingleElement": true,
        "optional": true
      },
      {
        "sourcePath": "$.phoneNumbers",
        "targetPath": "$.phoneNumbers",
        "preserveArrayWithSingleElement": true,
        "optional": true
      },
      {
        "sourcePath": "$.active",
        "targetPath": "$.active",
        "optional": true
      },
      {
        "sourcePath": "$.meta",
        "targetPath": "$.meta",
        "optional": true
      },
      {
        "sourcePath": "$.externalId",
        "targetPath": "$.externalId",
        "optional": true
      },
      {
        "sourcePath": "$.origin",
        "targetPath": "$.origin",
        "optional": true
      },
      {
        "sourcePath": "$.zoneId",
        "targetPath": "$.zoneId",
        "optional": true
      },
      {
        "sourcePath": "$.verified",
        "targetPath": "$.verified",
        "optional": true
      },
      {
        "constant": "urn:ietf:params:scim:schemas:core:2.0:User",
        "targetPath": "$.schemas[0]"
      }
    ],
    "scimEntityEndpoint": "Users"
  },
  "group": {
    "mappings": [
      {
        "sourcePath": "$.id",
        "targetPath": "$.id",
        "targetVariable": "entityIdSourceSystem"
      },
      {
        "sourceVariable": "entityBaseLocation",
        "targetPath": "$.meta.location",
        "targetVariable": "entityLocationSourceSystem",
        "functions": [
          {
            "type": "concatString",
            "suffix": "${entityIdSourceSystem}"
          }
        ]
      },
      {
        "sourcePath": "$.displayName",
        "targetPath": "$.displayName"
      },
      {
        "sourcePath": "$.description",
        "targetPath": "$.description",
        "optional": true
      },
      {
        "sourcePath": "$.members",
        "targetPath": "$.members",
        "preserveArrayWithSingleElement": true,
        "optional": true
      },
      {
        "sourcePath": "$.zoneId",
        "targetPath": "$.zoneId"
      },
      {
        "sourcePath": "$.meta",
        "targetPath": "$.meta",
        "optional": true
      },
      {
        "constant": "urn:ietf:params:scim:schemas:core:2.0:Group",
        "targetPath": "$.schemas[0]"
      }
    ],
    "scimEntityEndpoint": "Groups"
  }
}

    Code Syntax:

    {
  "user": {
    "mappings": [
      {
        "constant": "uaa-dummy-value",
        "targetPath": "$.id",
        "scope": "createEntity"
      },
      {
        "sourceVariable": "entityIdTargetSystem",
        "targetPath": "$.id"
      },
      {
        "sourcePath": "$.userName",
        "targetPath": "$.userName"
      },
      {
        "sourcePath": "$.name",
        "targetPath": "$.name",
        "optional": true
      },
      {
        "sourcePath": "$.emails",
        "targetPath": "$.emails",
        "preserveArrayWithSingleElement": true
      },
      {
        "condition": "$.emails[?(@.primary == true)].value == []",
        "targetPath": "$.emails[0].primary",
        "constant": true
      },
      {
        "sourcePath": "$.phoneNumbers",
        "preserveArrayWithSingleElement": true,
        "optional": true,
        "targetPath": "$.phoneNumbers"
      },
      {
        "sourcePath": "$.externalId",
        "optional": true,
        "targetPath": "$.externalId"
      },
      {
        "sourcePath": "$.verified",
        "targetPath": "$.verified",
        "optional": true
      },
      {
        "constant": "%uaa.origin%",
        "targetPath": "$.origin"
      },
      {
        "constant": "urn:scim:schemas:core:1.0",
        "targetPath": "$.schemas[0]"
      }
    ],
    "scimEntityEndpoint": "Users"
  },
  "group": {
    "mappings": [
      {
        "sourceVariable": "entityIdTargetSystem",
        "targetPath": "$.id"
      },
      {
        "sourcePath": "$.displayName",
        "targetPath": "$.displayName"
      },
      {
        "sourcePath": "$.description",
        "targetPath": "$.description",
        "optional": true
      },
      {
        "constant": "urn:scim:schemas:core:1.0",
        "targetPath": "$.schemas[0]"
      },
      {
        "sourcePath": "$.members",
        "targetPath": "$.members",
        "preserveArrayWithSingleElement": true,
        "optional": true,
        "functions": [
          {
            "condition": "@.type EMPTY false",
            "function": "toUpperCaseString",
            "applyOnElements": true,
            "applyOnAttribute": "type",
            "locale": "en_EN"
          }
        ]
      },
      {
        "constant": "%uaa.origin%",
        "targetPath": "$.members[*].origin",
        "preserveArrayWithSingleElement": true,
        "optional": true
      },
      {
        "sourcePath": "$.Operations",
        "targetPath": "$.Operations",
        "preserveArrayWithSingleElement": true,
        "scope": "patchEntity"
      },
      {
        "sourcePath": "$.schemas",
        "targetPath": "$.schemas",
        "preserveArrayWithSingleElement": true,
        "scope": "patchEntity"
      }
    ],
    "scimEntityEndpoint": "Groups"
  }
}

  9. Connect the external consumer to Identity Provisioning with the technical user you have created in step 2.

    If the external consumer system is SAP Identity Management, you can export the newly created proxy system as a SCIM repository from Identity Provisioning and import it in SAP Identity Management. This will create a SCIM repository in SAP Identity Management where most of the repository constants will be automatically filled in. You need to provide the technical user credentials that you have set up in step 2 and the SCIM assignment method as described below:

    • For AUTH_USER and AUTH_PASSWORD, enter your client ID and secret.

    • For the SCIM_ASSIGNMENT_METHOD constant, make sure the value is PUT.

    • For AUTH_USER and AUTH_PASSWORD, enter the user ID and password of the Identity Authentication technical user for which you have set permission Access Proxy System API.

    • For the SCIM_ASSIGNMENT_METHOD constant, make sure the value is PUT.

    Note:

    For external consumer systems, other than SAP Identity Management, you should also use the PUT method for modifying entities.

Next Steps

When a proxy system is connected to an external backend system (in the case of SAP Identity Management this means the exported CSV file is imported into the Identity Management Admin UI and a repository is configured), you can start managing the users and groups into this external system. Usually, the first operation is the initial load of the existing entities into your external system. When this load has finished, changes in the external system, such as creating new users or updating existing ones, can trigger CRUD requests back to the proxy system.

To see an example with SAP Identity Management, see Hybrid Scenario: SAP Identity Management → sections Next Steps and Future Identity Lifecycle.

Caution:

Effective September 2020, Shanghai (China) tenants that reside on SAP BTP, Neo environment can be only accessed on the following domain: dispatcher.cn1.platform.sapcloud.cn

So make sure you use the correct domain when you construct your REST API requests.

For example: GET https://ipsproxyabcd12345-xyz789.dispatcher.cn1.platform.sapcloud.cn/ipsproxy/api/v1/scim/bbb111aa-1234-aaaa-7777-1234567abcde/Users/s123456789

To learn more, see: Proxy Systems

Related Information

Cloud Foundry UAA: Users

Cloud Foundry UAA: Groups