Creating a custom attribute provider

A custom attribute provider enables you to append attributes that are not part of your primary identity provider (IdP) to a user's IBM Software Hub user profile. The custom attributes can be used to determine which dynamic user groups each user is a member of.

Who needs to complete this task?
  • A developer must create the custom attribute provider API server.
  • An IT administrator must deploy the API server.
When do you need to complete this task?

Complete this task if you want to use a custom attribute provider to automatically append attributes to a user's IBM Software Hub user profile.

About this task

A custom attribute provider is an API server. You can write the API server in your preferred language and deploy it in any environment. The API server must conform to the following requirements:

  • The cluster where IBM Software Hub is installed must be able to contact the server where the custom attribute provider is running.
  • The API server must accept the following API call:
    GET /v1/external/usermgmt/attributes?username=${USERNAME}
  • The response from the API server must be a non-nested JSON object that contains one or more key-value pairs. The values must be on the username that was passed to the API server. For example:
    {"customAttributeOne":"user-specific-value-1","customAttributeTwo":"user-specific-value-2"}

You can optionally configure the API server to require clients to provide:

  • A bearer token
  • A TLS certificate

What to do next

Now that you've created a custom attribute provider, you're ready to complete Connecting to your custom attribute provider.