Связаться с намиПопробовать бесплатно

Identity Provider API, gRPC: SynchronizationService.ListSupportedAttributes

Статья создана
Обновлена 15 декабря 2025 г.

Lists supported attributes for synchronization.

gRPC request

rpc ListSupportedAttributes (ListSupportedAttributesRequest) returns (ListSupportedAttributesResponse)

ListSupportedAttributesRequest

{
  "flavor": "AttributesFlavor"
}

Request to list supported attributes.

Field

Description

flavor

enum AttributesFlavor

Required field. Flavor of attributes to list.

  • ACTIVE_DIRECTORY: Active Directory attributes.

ListSupportedAttributesResponse

{
  "user_supported_attributes": [
    {
      "target_attribute": "UserTargetAttribute",
      "source_attributes": [
        {
          "type": "MappingType",
          "attributes": [
            "string"
          ]
        }
      ]
    }
  ],
  "group_supported_attributes": [
    {
      "target_attribute": "GroupTargetAttribute",
      "source_attributes": [
        {
          "type": "MappingType",
          "attributes": [
            "string"
          ]
        }
      ]
    }
  ]
}

Response message for SynchronizationService.ListSupportedAttributes.

Field

Description

user_supported_attributes[]

UserSupportedAttribute

List of supported user attributes.

group_supported_attributes[]

GroupSupportedAttribute

List of supported group attributes.

UserSupportedAttribute

Supported user attribute configuration.

Field

Description

target_attribute

enum UserTargetAttribute

Target attribute to map to.

  • FULL_NAME: Full name attribute.
  • GIVEN_NAME: Given name attribute.
  • FAMILY_NAME: Family name attribute.
  • EMAIL: Email attribute.
  • PHONE_NUMBER: Phone number attribute.
  • USERNAME: Username attribute.

source_attributes[]

SourceAttributes

List of source attribute configurations.

SourceAttributes

Source attribute configuration.

Field

Description

type

enum MappingType

Type of mapping.

  • DIRECT: Direct mapping from source to target.
  • EMPTY: Empty mapping (no source attribute).

attributes[]

string

List of source attribute names. Empty for EMPTY type.

GroupSupportedAttribute

Supported group attribute configuration.

Field

Description

target_attribute

enum GroupTargetAttribute

Target attribute to map to.

  • NAME: Name attribute.
  • DESCRIPTION: Description attribute.

source_attributes[]

SourceAttributes

List of source attribute configurations.
Предыдущая
GetSynchronizationSettings
Следующая
Overview