Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add recovery email parameter to MFA creation #82

Open
wants to merge 3 commits into
base: main
Choose a base branch
from
Open

Add recovery email parameter to MFA creation #82

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
d3e38ab
update api to add recovery_email parameter
ethancanne Apr 3, 2025
3695d05
Create new test case for when recovery type is used
ethancanne Apr 3, 2025
b93f5e1
pr suggestions
ethancanne Apr 3, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 2 additions & 1 deletion features/request/RequestContext.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -478,7 +478,8 @@ public function iCallMfaCreate()
$this->requestData['employee_id'],
$this->requestData['type'],
$this->requestData['label'],
$this->rpOrigin
$this->rpOrigin,
$this->requestData['recovery_email'],
);
}

Expand Down
4 changes: 3 additions & 1 deletion features/request/request.feature
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -319,6 +319,7 @@ Feature: Formatting requests for sending to the ID Broker API
And I provide an "employee_id" of "12345"
And I provide a "type" of "webauthn"
And I provide a "label" of "Blue security key"
And I provide a "recovery_email" of "[email protected]"
When I call mfaCreate
Then the method should be "POST"
And the url should be "https://api.example.com/mfa?rpOrigin=https%3A%2F%2Flogin.example.com"
Expand All @@ -328,7 +329,8 @@ Feature: Formatting requests for sending to the ID Broker API
{
"employee_id": "12345",
"type": "webauthn",
"label": "Blue security key"
"label": "Blue security key",
"recovery_email": "[email protected]"
}
"""

Expand Down
4 changes: 3 additions & 1 deletion src/IdBrokerClient.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -312,16 +312,18 @@ public function listUsers(array $fields = null, ?array $search = []): array
* @param string $type
* @param string|null $label
* @param string|null $rpOrigin
* @param string|null $recovery_email
* @return array|null
* @throws ServiceException
*/
public function mfaCreate(string $employee_id, string $type, string $label = null, string $rpOrigin = ''): ?array
public function mfaCreate(string $employee_id, string $type, string $label = null, string $rpOrigin = '', string $recovery_email = null): ?array
{
$result = $this->mfaCreateInternal([
'employee_id' => $employee_id,
'type' => $type,
'label' => $label,
'rpOrigin' => $rpOrigin,
'recovery_email' => $recovery_email,
]);
$statusCode = (int)$result[ 'statusCode' ];

Expand Down
7 changes: 6 additions & 1 deletion src/descriptions/id-broker-api.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -182,7 +182,7 @@
'required' => true,
'type' => 'string',
'location' => 'json',
'enum' => [ 'backupcode', 'totp', 'u2f', 'webauthn', 'manager' ],
'enum' => [ 'backupcode', 'totp', 'u2f', 'webauthn', 'manager', 'recovery' ],
],
'label' => [
'required' => false,
Expand All @@ -194,6 +194,11 @@
'type' => 'string',
'location' => 'query',
],
'recovery_email' => [
'required' => false,
'type' => 'string',
'location' => 'json',
],
],
],
'mfaDeleteInternal' => [
Expand Down