mirror of
https://github.com/LukeHagar/developer.sailpoint.com.git
synced 2025-12-10 12:27:47 +00:00
103 lines
2.7 KiB
YAML
103 lines
2.7 KiB
YAML
get:
|
|
operationId: getMFAConfig
|
|
tags:
|
|
- MFA Configuration
|
|
summary: Get configuration of a MFA method
|
|
description: >-
|
|
This API returns the configuration of a given MFA method.
|
|
A token with ORG_ADMIN authority is required to call this API.
|
|
security:
|
|
- oauth2: [idn:mfa-config:read]
|
|
parameters:
|
|
- in: path
|
|
name: method
|
|
schema:
|
|
type: string
|
|
example: okta-verify
|
|
required: true
|
|
description: >-
|
|
The name of the MFA method.
|
|
The currently supported method name is okta-verify.
|
|
responses:
|
|
"200":
|
|
description: MFA configuration of a given method.
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: "../schemas/MfaConfig.yaml"
|
|
example:
|
|
{
|
|
"enabled": true,
|
|
"host": "www.example.com",
|
|
"accessKey": "dk778Y3QlA5UqocYpdU3rEkzrK2D497y",
|
|
"identityAttribute": "email",
|
|
}
|
|
"400":
|
|
$ref: "../../v3/responses/400.yaml"
|
|
"401":
|
|
$ref: "../../v3/responses/401.yaml"
|
|
"403":
|
|
$ref: "../../v3/responses/403.yaml"
|
|
"429":
|
|
$ref: "../../v3/responses/429.yaml"
|
|
"500":
|
|
$ref: "../../v3/responses/500.yaml"
|
|
|
|
put:
|
|
operationId: setMFAConfig
|
|
tags:
|
|
- MFA Configuration
|
|
summary: Set configuration of a MFA method
|
|
description: >-
|
|
This API sets the configuration of a given MFA method.
|
|
A token with ORG_ADMIN authority is required to call this API.
|
|
security:
|
|
- oauth2: [idn:mfa-config:write]
|
|
parameters:
|
|
- in: path
|
|
name: method
|
|
schema:
|
|
type: string
|
|
example: okta-verify
|
|
required: true
|
|
description: >-
|
|
The name of the MFA method.
|
|
The currently supported method name is okta-verify.
|
|
requestBody:
|
|
required: true
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: "../schemas/MfaConfig.yaml"
|
|
example:
|
|
{
|
|
"enabled": true,
|
|
"host": "www.example.com",
|
|
"accessKey": "dk778Y3QlA5UqocYpdU3rEkzrK2D497y",
|
|
"identityAttribute": "email",
|
|
}
|
|
responses:
|
|
"200":
|
|
description: MFA configuration of a given method.
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: "../schemas/MfaConfig.yaml"
|
|
example:
|
|
{
|
|
"enabled": true,
|
|
"host": "www.example.com",
|
|
"accessKey": "dk778Y3QlA5UqocYpdU3rEkzrK2D497y",
|
|
"identityAttribute": "email",
|
|
}
|
|
"400":
|
|
$ref: "../../v3/responses/400.yaml"
|
|
"401":
|
|
$ref: "../../v3/responses/401.yaml"
|
|
"403":
|
|
$ref: "../../v3/responses/403.yaml"
|
|
"429":
|
|
$ref: "../../v3/responses/429.yaml"
|
|
"500":
|
|
$ref: "../../v3/responses/500.yaml"
|