<iframe src="https://www.googletagmanager.com/ns.html?id=GTM-M74D8PB" height="0" width="0" style="display:none;visibility:hidden">
Loading
Skip to NavigationSkip to Main Content
How to Read a Custom User Profile Attribute in Workflows
Workflows
Okta Classic Engine
Okta Identity Engine
Overview

In this article, learn how to read a custom user profile attribute. 

Applies To
  • Okta Workflows
Solution

Okta has a built-in default user type and allows the creation of custom user types.
From the Admin dashboard, go to Directory > Profile Editor. There should be one or more user types listed (it is possible to have more than two listed). In the screenshot below, two user types are shown:

  • User (default) – this is the default user type
  • Atko User – this is a custom user type

Okta User types 



Reading a custom attribute on the default user type

Clicking on User (default) opens up a profile editor shown below. 
 Profile attributes 


On the left side, see All attributes, Base attributes, or only Custom attributes. In this example, one custom attribute has been added to the default user type: 

  • LinkedIn profile

Custom user profile attribute


User Stella Green has the default user type and has the LinkedIn profile custom attribute set: 

Profile with a custom attribute 


The custom attribute is on the default user type. Use the Okta – Read User card to read the user information, including the custom attribute.

Reading user information with the Read User card


As the custom attribute is on the default user type, it is possible to choose to show the field from Settings (⚙️) > Choose fields:

Choosing card fields


Running the flow shows the custom LinkedIn profile attribute:

Read User card history

 


Reading a custom attribute on a custom user type

Now, let us learn how to read a custom attribute on a custom user type. 

Click on the custom Atko User user type:

User types


This custom user has one custom attribute, Portfolio URL:

A custom user type with a custom attribute


User Irene Johnson has a custom user type: 

Custom user type

Irene also has the Portfolio URL custom attribute set: 

Custom attribute on a custom user type 


If using the Okta – Read User card, the card does not know about the custom user type or the custom attribute. The Read User card only knows about the built-in default user type. 

Choosing card fields


The solution is to use the Custom API Action card to read a custom attribute on a custom user type. 


Reading a custom attribute on a custom user type with a Custom API Action card

Use Okta’s Custom API Action card to read user information, whether it’s the default user type or a custom user type. 

Make an API call to this endpoint: 

/api/v1/users/{userid}

This is a flow to read user information: 

Reading user information with Custom API Action card 


In the above flow:

  • The Assign card sets the user ID
  • The Concatenate card appends the user ID to the end point (/api/v1/users/{userid})
  • The Custom API Action makes an API call
  • The Get Multiple card retries the Portfolio URL attribute

Flow history: 

Reading user information flow – history 


Video

Watch the video below about this question and answer. 



Related References

 

Loading
How to Read a Custom User Profile Attribute in Workflows