mirror of
https://github.com/LukeHagar/api-specs.git
synced 2025-12-09 12:27:48 +00:00
113 lines
3.1 KiB
YAML
113 lines
3.1 KiB
YAML
get:
|
|
operationId: getIdentityAttribute
|
|
tags:
|
|
- Identity Attributes
|
|
summary: Get Identity Attribute
|
|
description: >-
|
|
This gets an identity attribute for a given technical name.
|
|
security:
|
|
- UserContextAuth: [ idn:identity-profile-attribute:read ]
|
|
parameters:
|
|
- in: path
|
|
name: name
|
|
schema:
|
|
type: string
|
|
description: The attribute's technical name.
|
|
required: true
|
|
example: displayName
|
|
responses:
|
|
"200":
|
|
description: The identity attribute with the given name
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: "../../v3/schemas/identity-attributes/IdentityAttribute.yaml"
|
|
"400":
|
|
$ref: "../../v3/responses/400.yaml"
|
|
"401":
|
|
$ref: "../../v3/responses/401.yaml"
|
|
"403":
|
|
$ref: "../../v3/responses/403.yaml"
|
|
"404":
|
|
$ref: "../../v3/responses/404.yaml"
|
|
"429":
|
|
$ref: "../../v3/responses/429.yaml"
|
|
"500":
|
|
$ref: "../../v3/responses/500.yaml"
|
|
put:
|
|
operationId: putIdentityAttribute
|
|
tags:
|
|
- Identity Attributes
|
|
summary: Update Identity Attribute
|
|
description: >-
|
|
This updates an existing identity attribute.
|
|
Making an attribute searchable requires that the `system`, `standard`, and `multi` properties be set to false.
|
|
security:
|
|
- UserContextAuth: [ idn:identity-profile-attribute:create ]
|
|
parameters:
|
|
- in: path
|
|
name: name
|
|
schema:
|
|
type: string
|
|
description: The attribute's technical name.
|
|
required: true
|
|
example: displayName
|
|
requestBody:
|
|
required: true
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: "../../v3/schemas/identity-attributes/IdentityAttribute.yaml"
|
|
responses:
|
|
"200":
|
|
description: The identity attribute was updated successfully
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: "../../v3/schemas/identity-attributes/IdentityAttribute.yaml"
|
|
"400":
|
|
$ref: "../../v3/responses/400.yaml"
|
|
"401":
|
|
$ref: "../../v3/responses/401.yaml"
|
|
"403":
|
|
$ref: "../../v3/responses/403.yaml"
|
|
"404":
|
|
$ref: "../../v3/responses/404.yaml"
|
|
"429":
|
|
$ref: "../../v3/responses/429.yaml"
|
|
"500":
|
|
$ref: "../../v3/responses/500.yaml"
|
|
delete:
|
|
operationId: deleteIdentityAttribute
|
|
tags:
|
|
- Identity Attributes
|
|
summary: Delete Identity Attribute
|
|
description: >-
|
|
This deletes an identity attribute with the given name.
|
|
The `system` and `standard` properties must be set to false before you can delete an identity attribute.
|
|
security:
|
|
- UserContextAuth: [ idn:identity-profile-attribute:delete ]
|
|
parameters:
|
|
- in: path
|
|
name: name
|
|
schema:
|
|
type: string
|
|
description: The attribute's technical name.
|
|
required: true
|
|
example: displayName
|
|
responses:
|
|
"204":
|
|
$ref: "../../v3/responses/204.yaml"
|
|
"400":
|
|
$ref: "../../v3/responses/400.yaml"
|
|
"401":
|
|
$ref: "../../v3/responses/401.yaml"
|
|
"403":
|
|
$ref: "../../v3/responses/403.yaml"
|
|
"404":
|
|
$ref: "../../v3/responses/404.yaml"
|
|
"429":
|
|
$ref: "../../v3/responses/429.yaml"
|
|
"500":
|
|
$ref: "../../v3/responses/500.yaml"
|