List directory attribute mappings

GET 
/api/web/v1/directories/:id/attributemappings

List all directory attribute mappings for a given directory. Caller requires the DIRECTORIES:VIEW permission.

Request

Path Parameters

id stringrequired

The UUID of the directory whose directory attribute mappings are to be returned.

Responses

200

Successful

application/json

Schema

Schema

• Array [

directoryAttributeName string

The name of the directory attribute being mapped.

directoryId string

The UUID of the Directory the attribute mapping belongs to.

id string

The UUID of the attribute mapping.

userAttribute

object

Information about user attribute definitions.

id string

The UUID for this user attribute. Generated when the user attribute is created.

mandatory booleanrequired

A flag indicating if users must have a value for this user attribute.

name stringrequired

The name of this user attribute.

systemDefined booleanrequired

A flag indicating if this user attribute is one of the system defined user attributes.

type string

Possible values: [NONE, OTP_EMAIL, OTP_SMS, OTP_VOICE]

Type of user attribute. Currently only used to specify the type of contact if the attribute is to be used for OTP delivery.

unique booleanrequired

A flag indicating if this attribute is intended to be unique.

userAttributeId string

The UUID of the Identity as a Service User Attribute being mapped to.

• ]

Example (from schema)

[
  {
    "directoryAttributeName": "givenName",
    "directoryId": "6781549d-433c-44ea-a42f-4705c26f3245",
    "id": "6781549d-433c-44ea-a42f-4705c26f3245",
    "userAttribute": {
      "id": "string",
      "mandatory": true,
      "name": "string",
      "systemDefined": true,
      "type": "OTP_EMAIL",
      "unique": true
    },
    "userAttributeId": "6781549d-433c-44ea-a42f-4705c26f3245"
  }
]

400

Bad Request

application/json

Schema

Schema

errorCode string

Error Codes specific to cause of failure.

errorMessage string

Additional Error Message describing the error.

parameters object[]

Optional additional error information.

Example (from schema)

{
  "errorCode": "invalid_user_response",
  "errorMessage": "Application id cannot be null",
  "parameters": [
    {}
  ]
}

401

Access denied

application/json

Schema

Schema

errorCode string

Error Codes specific to cause of failure.

errorMessage string

Additional Error Message describing the error.

parameters object[]

Optional additional error information.

Example (from schema)

{
  "errorCode": "invalid_user_response",
  "errorMessage": "Application id cannot be null",
  "parameters": [
    {}
  ]
}

403

Forbidden

application/json

Schema

Schema

errorCode string

Error Codes specific to cause of failure.

errorMessage string

Additional Error Message describing the error.

parameters object[]

Optional additional error information.

Example (from schema)

{
  "errorCode": "invalid_user_response",
  "errorMessage": "Application id cannot be null",
  "parameters": [
    {}
  ]
}

404

Not Found

application/json

Schema

Schema

errorCode string

Error Codes specific to cause of failure.

errorMessage string

Additional Error Message describing the error.

parameters object[]

Optional additional error information.

Example (from schema)

{
  "errorCode": "invalid_user_response",
  "errorMessage": "Application id cannot be null",
  "parameters": [
    {}
  ]
}

409

Conflict

application/json

Schema

Schema

errorCode string

Error Codes specific to cause of failure.

errorMessage string

Additional Error Message describing the error.

parameters object[]

Optional additional error information.

Example (from schema)

{
  "errorCode": "invalid_user_response",
  "errorMessage": "Application id cannot be null",
  "parameters": [
    {}
  ]
}

Loading...