Skip to main content

SelfServiceAction

Represents an available self-service action that a user or identity can perform.

type SelfServiceAction {
  description: String
  enabled: Boolean!
  id: ID!
  identityStore: IdentityStore
  isEligible: Boolean!
  title: String!
  unavailableReason: String
  unavailableReasonCode: SelfServiceActionUnavailableReason
}

Fields​

SelfServiceAction.description ● String scalar​

A detailed description of what the action does.

SelfServiceAction.enabled ● Boolean! non-null scalar​

Indicates whether the action is administratively enabled.

SelfServiceAction.id ● ID! non-null scalar​

The unique identifier of the self-service action.

SelfServiceAction.identityStore ● IdentityStore object​

The identity store associated with this action.

SelfServiceAction.isEligible ● Boolean! non-null scalar​

Indicates whether the current user meets the technical requirements to perform this action.

SelfServiceAction.title ● String! non-null scalar​

The display title of the action.

SelfServiceAction.unavailableReason ● String scalar​

If the action is not enabled or not eligible, provides a reason why it is unavailable.

SelfServiceAction.unavailableReasonCode ● SelfServiceActionUnavailableReason enum​

A machine-readable code for the reason why the action is unavailable.

Returned By​

checkMyTapEligibility query

Member Of​

Identity object