Creating trusted profiles

Establishing trust with federated users in the console

Complete the following steps to define which federated users can access specific resources:

1. Enable authentication from an external identity provider.

2. In the IBM Cloud console, click Manage > Access (IAM), and select Trusted profiles.

3. Click Create profile.

4. Describe your profile by providing a name and a description, then click Continue.

   In the description, provide a list of actions available for this trusted profile.

5. You can create the trusted profile before you add details by selecting Decide later. Or, establish trust by completing the following steps:

   1. Select Federated users as a trusted entity type from the list.

   2. Select Users federated by IBMid or Users federated by IBM Cloud App ID as the authentication method and input the default identity provider (IdP) you enabled in step 1.

      If the users that you are creating a trusted profile for use IBM Cloud App ID, create the trusted profile as an App ID user, and likewise for IBMid. This way, your own SAML attributes can give you an idea of how to structure the trusted profile conditions. Other users with the same IdP can have different SAML attributes. Use your own attributes only as a hint. To use attributes in a claim that are different than your own, input them manually.

   3. Add conditions based on your IdP data to define how and when federated users can apply the profile.

      • By clicking Add a condition, you can define multiple conditions. Federated users must meet all the conditions to be included in the trusted profile. For more information about the fields that are used to create conditions, see IAM condition properties.
      • Click View identity provider (IdP) data to search attribute names and values in your own personal data from your IdP. For more information, see Using IdP data to build trusted profiles.

   4. Define the session duration for how long a user can apply the profile before they must reauthenticate.

6. Click Continue.

7. (Optional) Assign access to the trusted profile.

8. Or, click Create without assigning any access.

For more information about the fields that are used to create conditions for trusted profiles, see IAM condition properties.

Establishing trust with compute resources in the console

Complete the following steps to set up better control over granting access to compute resources.

IBM Cloud Kubernetes Service supports only trusted profiles for versions 1.21 and newer. Free IBM Cloud Kubernetes Service clusters create only earlier versions. You have the choice to create clusters with an earlier version with the standard plan, so be sure to select version 1.21 or newer.

1. In the IBM Cloud console, click Manage > Access (IAM), and select Trusted profiles.

2. Click Create profile.

3. Describe your profile by providing a name and a description, and click Continue.

4. You can create the trusted profile before you add details by selecting Decide later. Or, establish trust by completing the following steps:

   1. Select Compute resources and select a compute service type from the list.
   2. If you select the option for All service resources, you can define multiple conditions to filter resources for the selected compute service type by clicking Add a condition. These conditions are based on attributes, such as resource groups or location, and apply to all existing and future resources. Resources must meet all the conditions to be included in the trusted profile.

   The Kubernetes namespace and service account names that you enter do not have to exist already. Any future namespaces or service accounts with these names can establish trust. To list existing namespaces, log in to your cluster and run kubectl get ns. To list existing service accounts, log in to your cluster and run kubectl get sa -n <namespace>. You can also enter default for both. For more information, see Using Trusted Profiles in your Kubernetes and Red Hat OpenShift Clusters.

   1. If you select Specific resources, you can establish trust with one or more existing compute resource instances directly without conditions. For example, a Kubernetes cluster.

5. Click Continue.

6. (Optional) Assign access to the trusted profile.

7. Or, click Create without assigning any access.

For more information about the fields that are used to create conditions for trusted profiles, see IAM condition properties.

Establishing trust with IBM Cloud services in the console

An IBM Cloud service in your account or another account might need a token to run an operation in your account.

Example 1

A Project service instance in another account can assume a trusted profile to securely deploy an architecture in your account without the need for key rotation. For more information, see Using trusted profiles to authorize a project to deploy an architecture.

Example 2

A private catalog is an instance of the Catalog Management service that is identified by a CRN. You might want to validate products from your private catalog in an account that’s separate from the one that contains your catalog. You can give a private catalog access to create resources for validation in a target account by creating a trusted profile in the target account. Then you establish trust with the catalog by using the catalog CRN to link the service instance to the trusted profile. For more information, see Setting up a target account for validation.

Sharing resources across accounts by using trusted profiles works for a limited set of services and is not a general method for cross-account access for services.

Complete the following steps to define how an IBM Cloud service can access specific resources in your account:

1. Ask the administrator of the service for the Cloud Resource Name (CRN) that uniquely identifies the service instance. The CRN is used to authorize operations.

   The service administrator can find the CRN by going to the Navigation Menu icon > Resource list and clicking the name of the service that you're targeting. In the Details section, copy the CRN. For a private catalog CRN, go to Manage > Catalogs > Private catalogs and select the private catalog. Click Actions... > Edit catalog details to find the Catalog CRN.

2. In the IBM Cloud console, click Manage > Access (IAM), and select Trusted profiles.

3. Click Create profile.

4. Define your profile by providing a name and a description, and click Continue.

   In the description, provide a list of actions that are available for the trusted profile.

5. You can create the trusted profile before you add details by selecting Decide later. Or, establish trust by completing the following steps:

   1. Select IBM Cloud® services.
   2. Enter the CRN that the service administrator provided to you.

   IBM Cloud services are static identities that don't use conditions to establish trust. Instead, you establish trust by using the CRN to create a direct link with the trusted entity.

6. Click Continue.

7. (Optional) Assign access to the trusted profile.

8. Or, click Create without assigning any access.

Establishing trust with service IDs in the console

You can use trusted profiles to give a service ID cross-account access and access to call classic infrastructure services. To give a service ID in one account access to a target account, create the trusted profile in the target account. Complete the following steps to define how a service ID can access specific resources in your account:

1. Ask an administrator in the other account for the service ID value that identifies the service ID.

   An administrator can find the service ID value by going to Manage > Access (IAM) > Service IDs, and selecting the service ID that you want to target. Click Details and copy the ID that begins with ServiceId.

2. In the IBM Cloud console, click Manage > Access (IAM), and select Trusted profiles.

3. Click Create profile.

4. Define your profile by providing a name and a description, and click Continue.

   In the description, provide a list of actions that are available for this trusted profile.

5. You can create the trusted profile before you add details by selecting Decide later. Or, establish trust by completing the following steps:

   1. Select Service IDs
   2. Enter the service ID value that the administrator provided to you.

6. Click Continue.

7. (Optional) Assign access to the trusted profile.

8. Or, click Create without assigning any access.

Service IDs are static identities that don't use conditions to establish trust. Instead, you establish trust by using the ID value from the service ID's metadata to create a direct link with the trusted entity.

Assigning access to the trusted profile

After you establish trust with federated users, compute resources, an IBM Cloud service, or a service ID, you can assign access.

You can assign classic infrastructure access only if your account is linked to a Softlayer account.

1. Assign access.
   • Assign access to the trusted profile by adding it to one or more access groups. This way, you can use the policies that exist in the access groups you've created.
     1. Select Access groups and select all the groups that you want to add the trusted profile to. You can assign users to only the access groups that you have access to manage.
     2. Click Add.
   • Assign access to the trusted profile with an access policy.
     1. Select Access policy. Based on your level of access, you can assign IAM policies and classic infrastructure permissions.
     2. Select a single service or a group of services, like All Identity and Access enabled services, All Account Management services, or All IAM Account Management services. Then, click Next.
     3. Scope the access to All resources or Specific resources based on selected attributes. Then, click Next.
     4. Select any combination of roles and permissions to define the scope of access, and click Review.
     5. Click Add to add your policy configuration to your summary.
     6. You can assign Classic infrastructure access by selecting a user, device, or service, then any combination of granular permissions.
2. Click Create.

Establishing trust with federated users by using the CLI

Complete the following steps to define which federated users can access specific resources:

1. Enable authentication from an external identity provider.

2. Create a trusted profile by running the following command:

   ibmcloud iam trusted-profile-create my-profile -d "sample trusted profile"
   

   For more information, see the CLI reference.

3. To create conditions for your trusted profile, run the ibmcloud iam trusted-profile-rule-create command:

   ibmcloud iam trusted-profile-rule-create my-profile --name my-rule --type Profile-SAML --conditions claim:cn,operator:EQUALS,value:my_user --realm-name https://w3id.sso.ibm.com/auth/sps/samlidp2/saml20 --expiration 1200
   

   For more information, see the CLI reference.

4. Create an access policy with the Viewer role for all resources in the account by running the following command:

   ibmcloud iam trusted-profile-policy-create --roles Viewer
   

   For more information, see the CLI reference.

Establishing trust with compute resources by using the CLI

Complete the following steps to set up better control over granting access to compute resources.

IBM Cloud Kubernetes Service supports only trusted profiles for versions 1.21 and newer. Free IBM Cloud Kubernetes Service clusters create only earlier versions. You have the choice to create clusters with an earlier version with the standard plan, so be sure to select version 1.21 or newer.

1. Create a trusted profile by running the following command:

   ibmcloud iam trusted-profile-create sample-compute-profile -d "sample trusted profile for compute resources"
   

   For more information, see the CLI reference.

2. Create conditions for your trusted profile by using the ibmcloud iam trusted-profile-rule-create command:

   ibmcloud iam trusted-profile-rule-create sample-compute-profile --name cr-rule --type Profile-CR --conditions claim:namespace,operator:EQUALS,value:default --conditions claim:crn,operator:EQUALS,value:crn:test:bluemix:public:containers-kubernetes:us-south:a/test:: --cr-type IKS_SA
   

   For more information, see the CLI reference.

   You can also create a direct link:

   ibmcloud iam trusted-profile-link-create sample-compute-profile --name my_link --cr-type IKS_SA --link-name default  --link-namespace default --link-crn my_compute_resource_crn
   

   For more information, see the CLI reference.

3. Create an access policy by running the following command:

   ibmcloud iam trusted-profile-policy-create --roles Viewer
   

   For more information, see the CLI reference.

Establishing trust with IBM Cloud services by using the CLI

An IBM Cloud service in another account might need a token to execute an operation in your account. Complete the following steps to define how an IBM Cloud service can access specific resources in your account:

1. Ask the administrator on the service in another account for the CRN that uniquely identifies the service instance. The CRN is used to authorize operations.

   The service administrator can find the CRN by going to the Navigation Menu icon > Resource list and clicking the service that you're targeting. In the Details section, copy the CRN.

2. Create the trust relationship with a direct link:

   ibmcloud iam trusted-profile-link-create sample-cloudservice-profile --name my_cloudservice_link --link-crn `crn:version:cname:ctype:service-name:location:scope:service-instance:resource-type:resource`
   

   For more information, see the CLI reference.

3. Create an access policy by running the following command:

   ibmcloud iam trusted-profile-policy-create --roles Viewer
   

   For more information, see the CLI reference.

Establishing trust with service IDs by using the CLI

Complete the following steps to define how a service ID can access specific resources in your account:

You can use trusted profiles to give a service ID cross-account access and access to call Classic Infrastructure services.

1. Ask an administrator in the other account for the service ID value that identifies the service ID.

   An administrator can find the service ID value by going to Manage > Access (IAM) > Service IDs and selecting the service ID that you want to target. Click Details and copy the ID that begins with ServiceId.

2. Create the trust relationship with a direct link:

   ibmcloud iam trusted-profile-link-create sample-serviceid-profile --name my_serviceid_link --link-crn `crn:version:cname:ctype:service-name:location:scope:service-instance:resource-type:resource`
   

   For more information, see the CLI reference.

3. Create an access policy by running the following command:

   ibmcloud iam trusted-profile-policy-create --roles Viewer
   

   For more information, see the CLI reference.

Assigning access to the trusted profile by using the CLI

After you establish trust with federated users, compute resources, an IBM Cloud service, or a service ID, you can assign access.

You can assign classic infrastructure access only if your account is linked to a Softlayer account.

Use the command trusted-profile-policy-create to assign an access policy to the trusted profile. The following example assigns a policy with the Administrator role on All Account Management services:

ibmcloud iam trusted-profile-policy-create Profile-36f5c562-1t36-4442-b7f0-2663c85386f1 --roles Administrator --attributes serviceType=service

Establishing trust with federated users by using the API

Complete the following steps to define which federated users can access specific resources:

1. Enable authentication from an external identity provider.

2. Create a trusted profile by specifying your account ID.

   curl -X POST 'https://iam.cloud.ibm.com/v1/profiles' -H 'Authorization: Bearer TOKEN' -H 'Content-Type: application/json' -H 'Accept: application/json' -d '{
   "name": "My Nice Profile",
   "description": "My Nice Profile - desc",
   "account_id": "ACCOUNT_ID"
   }'
   

   In the description, provide a list of actions available for this trusted profile.

3. Create conditions for your trusted profile. For federated users, set the type attribute to Profile-SAML. The realm-name is the IdP URL. For more information, see the IAM Identity Services API.

   curl -X POST 'https://iam.cloud.ibm.com/v1/profiles/PROFILE_ID/rules' -H 'Authorization: Bearer TOKEN' -H 'Content-Type: application/json' -H 'Accept: application/json' -d '{
   "type": "Profile-SAML",
   "realm_name": "https://www.example.org/my-nice-idp",
   "expiration": 43200,
   "conditions": [
   {
   "claim": "groups",
   "operator": "EQUALS",
   "value": "\"cloud-docs-dev\""
      }
      ]
   }'
   

   There is a limit of 20 claim rules per trusted profile.

4. (Optional) Assign access to the trusted profile.

Establishing trust with compute resources with the API

Complete the following steps to set up better control over granting access to compute resources.

IBM Cloud Kubernetes Service supports only trusted profiles for versions 1.21 and newer. Free IBM Cloud Kubernetes Service clusters create only earlier versions. You have the choice to create clusters with an earlier version with the standard plan, so be sure to select version 1.21 or newer.

1. Create a trusted profile by specifying your account ID.

   curl -X POST 'https://iam.cloud.ibm.com/v1/profiles' -H 'Authorization: Bearer TOKEN' -H 'Content-Type: application/json' -H 'Accept: application/json' -d '{
   "name": "My Nice Profile",
   "description": "My Nice Profile - desc",
   "account_id": "ACCOUNT_ID"
   }'
   

   In the description, provide a list of actions available for this trusted profile.

2. Create a claim rule for your trusted profile that follows the principle of least privilege by specifying conditions that target only the resources that need access. Conditions apply to all existing future resources. You can also create a direct link with specific, existing resources.

   Create conditions

   For compute resources, set the type attribute to Profile-CR. For more information, see the IAM Identity Services API.

   curl -X POST 'https://iam.cloud.ibm.com/v1/profiles/PROFILE_ID/rules' -H 'Authorization: Bearer TOKEN' -H 'Content-Type: application/json' -H 'Accept: application/json' -d '{
   "type": "Profile-CR",
   "conditions": [
   {
   "claim": "namespace",
   "operator": "EQUALS",
   "value": "\"default123\""
      }
      ]
   }'
   

   There is a limit of 20 claim rules per trusted profile.

   Create a direct link

   You can establish a direct link with specific, existing resources.

   curl -X POST 'https://iam.cloud.ibm.com/v1/profiles/PROFILE_ID/links' -H 'Authorization: Bearer TOKEN' -H 'Content-Type: application/json' -H 'Accept: application/json' -d '{
      "name": "my link",
      "cr_type": "VSI",
      "link": {
   "crn": "crn:v1:staging:public:iam-identity::a/18e3020749ce4744b0b472466d61fdb4::computeresource:Fake-Compute-Resource",
   "namespace": "default",
   "name": "my compute resource name"
      }
   }'
   

3. (Optional) Assign access to the trusted profile.

Assigning access to the trusted profile by using the API

After you establish trust with federated users, compute resources, an IBM Cloud service, or a service ID, you can assign access.

You can assign classic infrastructure access only if your account is linked to a Softlayer account.

The following example assigns a policy with the Administrator role on All Account Management services:

curl -X POST \
'https://iam.cloud.ibm.com/v1/policies' \
-H 'Authorization: $TOKEN'\
-H 'Content-Type: application/json'\
-d '{
  "type": "access",
  "subjects": [
    {
      "attributes": [
        {
          "name": "iam_id",
          "value": "Iam-Profile-35f55552-1e36-4442-z7f0-2673c85386f9"
        }
      ]
    }'
  ],
  "roles":[
    {
      "role_id": "crn:v1:bluemix:public:iam::::role:Administrator"
    }
  ],
  "resources":[
    {
      "attributes": [
        {
          "name": "accountId",
          "value": "$ACCOUNT_ID"
        },
        {
          "name": "serviceType",
          "value": "platform-service"
        }
      ]
    }
  ]
}'

SubjectAttribute subjectAttribute = new SubjectAttribute.Builder()
        .name("iam_id")
        .value("Iam-Profile-35f55552-1e36-4442-z7f0-2673c85386f9")
        .build();

PolicySubject policySubjects = new PolicySubject.Builder()
        .addAttributes(subjectAttribute)
        .build();

PolicyRole policyRoles = new PolicyRole.Builder()
        .roleId("crn:v1:bluemix:public:iam::::role:Administrator")
        .build();

ResourceAttribute accountIdResourceAttribute = new ResourceAttribute.Builder()
        .name("accountId")
        .value("exampleAccountId")
        .operator("stringEquals")
        .build();

ResourceAttribute serviceTypeResourceAttribute = new ResourceAttribute.Builder()
        .name("serviceType")
        .value("platform-service")
        .operator("stringEquals")
        .build();

PolicyResource policyResources = new PolicyResource.Builder()
        .addAttributes(accountIdResourceAttribute)
        .addAttributes(serviceTypeResourceAttribute)
        .build();

CreatePolicyOptions options = new CreatePolicyOptions.Builder()
        .type("access")
        .subjects(Arrays.asList(policySubjects))
        .roles(Arrays.asList(policyRoles))
        .resources(Arrays.asList(policyResources))
        .build();

Response<Policy> response = service.createPolicy(options).execute();
Policy policy = response.getResult();

System.out.println(policy);

const policySubjects = [
  {
    attributes: [
      {
        name: 'iam_id',
        value: "Iam-Profile-35f55552-1e36-4442-z7f0-2673c85386f9",
      },
    ],
  },
];
const policyRoles = [
  {
    role_id: 'crn:v1:bluemix:public:iam::::role:Administrator',
  },
];
const accountIdResourceAttribute = {
  name: 'accountId',
  value: 'exampleAccountId',
  operator: 'stringEquals',
};
const serviceTypeResourceAttribute = {
  name: 'serviceType',
  value: 'platform-service',
  operator: 'stringEquals',
};
const policyResources = [
  {
    attributes: [accountIdResourceAttribute, serviceTypeResourceAttribute]
  },
];
const params = {
  type: 'access',
  subjects: policySubjects,
  roles: policyRoles,
  resources: policyResources,
};

iamPolicyManagementService.createPolicy(params)
  .then(res => {
    examplePolicyId = res.result.id;
    console.log(JSON.stringify(res.result, null, 2));
  })
  .catch(err => {
    console.warn(err)
  });

policy_subjects = PolicySubject(
  attributes=[SubjectAttribute(name='iam_id', value='Iam-Profile-35f55552-1e36-4442-z7f0-2673c85386f9')])
policy_roles = PolicyRole(
  role_id='crn:v1:bluemix:public:iam::::role:Administrator')
account_id_resource_attribute = ResourceAttribute(
  name='accountId', value=example_account_id)
service_name_resource_attribute = ResourceAttribute(
  name='serviceType', value='platform-service')
policy_resources = PolicyResource(
  attributes=[account_id_resource_attribute,
        service_type_resource_attribute])

policy = iam_policy_management_service.create_policy(
  type='access',
  subjects=[policy_subjects],
  roles=[policy_roles],
  resources=[policy_resources]
).get_result()

print(json.dumps(policy, indent=2))

subjectAttribute := &iampolicymanagementv1.SubjectAttribute{
  Name:  core.StringPtr("iam_id"),
  Value: core.StringPtr("Iam-Profile-35f55552-1e36-4442-z7f0-2673c85386f9"),
}
policySubjects := &iampolicymanagementv1.PolicySubject{
  Attributes: []iampolicymanagementv1.SubjectAttribute{*subjectAttribute},
}
policyRoles := &iampolicymanagementv1.PolicyRole{
  RoleID: core.StringPtr("crn:v1:bluemix:public:iam::::role:Administrator"),
}
accountIDResourceAttribute := &iampolicymanagementv1.ResourceAttribute{
  Name:     core.StringPtr("accountId"),
  Value:    core.StringPtr("ACCOUNT_ID"),
  Operator: core.StringPtr("stringEquals"),
}
serviceTypeResourceAttribute := &iampolicymanagementv1.ResourceAttribute{
  Name:     core.StringPtr("serviceType"),
  Value:    core.StringPtr("platform-service"),
  Operator: core.StringPtr("stringEquals"),
}
policyResources := &iampolicymanagementv1.PolicyResource{
  Attributes: []iampolicymanagementv1.ResourceAttribute{
    *accountIDResourceAttribute, *serviceTypeResourceAttribute},
}

options := iamPolicyManagementService.NewCreatePolicyOptions(
  "access",
  []iampolicymanagementv1.PolicySubject{*policySubjects},
  []iampolicymanagementv1.PolicyRole{*policyRoles},
  []iampolicymanagementv1.PolicyResource{*policyResources},
)

policy, response, err := iamPolicyManagementService.CreatePolicy(options)
if err != nil {
  panic(err)
}
b, _ := json.MarshalIndent(policy, "", "  ")
fmt.Println(string(b))