Skip to content

feat: Add Self Service Profiles endpoints #795

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

Open
tim-zitcha wants to merge 5 commits into
base: main
Choose a base branch
from
Open

feat: Add Self Service Profiles endpoints #795

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
b768ca2
feat: Add Self Service Profiles endpoints
tim-zitcha Jun 8, 2025
a78144b
Merge remote-tracking branch 'origin/main' into add-self-service-prof…
tim-zitcha Oct 3, 2025
f486642
Merge branch 'main' into add-self-service-profiles
kishore7snehil Dec 3, 2025
0514d97
Merge branch 'auth0:main' into add-self-service-profiles
tim-zitcha Mar 2, 2026
3393392
fix: Address PR review bot comments
tim-zitcha Mar 2, 2026
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
9 changes: 7 additions & 2 deletions src/API/Management.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,9 +4,9 @@

namespace Auth0\SDK\API;

use Auth0\SDK\API\Management\{Actions, AttackProtection, Blacklists, ClientGrants, Clients, Connections, DeviceCredentials, EmailTemplates, Emails, Grants, Guardian, Jobs, Keys, LogStreams, Logs, NetworkAcls, Organizations, RefreshTokens, ResourceServers, Roles, Rules, Sessions, Stats, Tenants, Tickets, UserBlocks, Users, UsersByEmail};
use Auth0\SDK\API\Management\{Actions, AttackProtection, Blacklists, ClientGrants, Clients, Connections, DeviceCredentials, EmailTemplates, Emails, Grants, Guardian, Jobs, Keys, LogStreams, Logs, NetworkAcls, Organizations, RefreshTokens, ResourceServers, Roles, Rules, SelfServiceProfiles, Sessions, Stats, Tenants, Tickets, UserBlocks, Users, UsersByEmail};
use Auth0\SDK\Configuration\SdkConfiguration;
use Auth0\SDK\Contract\API\Management\{ActionsInterface, AttackProtectionInterface, BlacklistsInterface, ClientGrantsInterface, ClientsInterface, ConnectionsInterface, DeviceCredentialsInterface, EmailTemplatesInterface, EmailsInterface, GrantsInterface, GuardianInterface, JobsInterface, KeysInterface, LogStreamsInterface, LogsInterface, NetworkAclsInterface, OrganizationsInterface, RefreshTokensInterface, ResourceServersInterface, RolesInterface, RulesInterface, SessionsInterface, StatsInterface, TenantsInterface, TicketsInterface, UserBlocksInterface, UsersByEmailInterface, UsersInterface};
use Auth0\SDK\Contract\API\Management\{ActionsInterface, AttackProtectionInterface, BlacklistsInterface, ClientGrantsInterface, ClientsInterface, ConnectionsInterface, DeviceCredentialsInterface, EmailTemplatesInterface, EmailsInterface, GrantsInterface, GuardianInterface, JobsInterface, KeysInterface, LogStreamsInterface, LogsInterface, NetworkAclsInterface, OrganizationsInterface, RefreshTokensInterface, ResourceServersInterface, RolesInterface, RulesInterface, SelfServiceProfilesInterface, SessionsInterface, StatsInterface, TenantsInterface, TicketsInterface, UserBlocksInterface, UsersByEmailInterface, UsersInterface};
use Auth0\SDK\Contract\API\{AuthenticationInterface, ManagementInterface};
use Auth0\SDK\Utility\{HttpClient, HttpResponse, HttpResponsePaginator};
use Psr\Cache\CacheItemPoolInterface;
Expand Down Expand Up @@ -227,6 +227,11 @@ public function rules(): RulesInterface
return Rules::instance($this->getHttpClient());
}

public function selfServiceProfiles(): SelfServiceProfilesInterface
{
return SelfServiceProfiles::instance($this->getHttpClient());
}

public function sessions(): SessionsInterface
{
return Sessions::instance($this->getHttpClient());
Expand Down
208 changes: 208 additions & 0 deletions src/API/Management/SelfServiceProfiles.php
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,208 @@
<?php

declare(strict_types=1);

namespace Auth0\SDK\API\Management;

use Auth0\SDK\Contract\API\Management\SelfServiceProfilesInterface;
use Auth0\SDK\Utility\Request\RequestOptions;
use Auth0\SDK\Utility\Toolkit;
use Psr\Http\Message\ResponseInterface;

/**
* Handles requests to the Self Service Profiles endpoint of the v2 Management API.
*
* @see https://auth0.com/docs/api/management/v2/self-service-profiles
*/
final class SelfServiceProfiles extends ManagementEndpoint implements SelfServiceProfilesInterface
{
public function create(
string $name,
array $body,
?RequestOptions $options = null,
): ResponseInterface {
[$name] = Toolkit::filter([$name])->string()->trim();
[$body] = Toolkit::filter([$body])->array()->trim();

Toolkit::assert([
[$name, \Auth0\SDK\Exception\ArgumentException::missing('name')],
])->isString();

/** @var array<mixed> $body */

return $this->getHttpClient()
->method('post')
->addPath(['self-service-profiles'])
->withBody(
(object) Toolkit::merge([[
'name' => $name,
], $body]),
)
->withOptions($options)
->call();
}

public function createSsoTicket(
string $id,
?array $body = null,
?RequestOptions $options = null,
): ResponseInterface {
[$id] = Toolkit::filter([$id])->string()->trim();
[$body] = Toolkit::filter([$body])->array()->trim();

Toolkit::assert([
[$id, \Auth0\SDK\Exception\ArgumentException::missing('id')],
])->isString();

/** @var array<mixed> $body */

return $this->getHttpClient()
->method('post')
->addPath(['self-service-profiles', $id, 'sso-ticket'])
->withBody((object) $body)
->withOptions($options)
->call();
}

public function delete(
string $id,
?RequestOptions $options = null,
): ResponseInterface {
[$id] = Toolkit::filter([$id])->string()->trim();

Toolkit::assert([
[$id, \Auth0\SDK\Exception\ArgumentException::missing('id')],
])->isString();

return $this->getHttpClient()
->method('delete')
->addPath(['self-service-profiles', $id])
->withOptions($options)
->call();
}

public function get(
string $id,
?RequestOptions $options = null,
): ResponseInterface {
[$id] = Toolkit::filter([$id])->string()->trim();

Toolkit::assert([
[$id, \Auth0\SDK\Exception\ArgumentException::missing('id')],
])->isString();

return $this->getHttpClient()
->method('get')
->addPath(['self-service-profiles', $id])
->withOptions($options)
->call();
}

public function getAll(
?array $parameters = null,
?RequestOptions $options = null,
): ResponseInterface {
[$parameters] = Toolkit::filter([$parameters])->array()->trim();

/** @var array<null|int|string> $parameters */

return $this->getHttpClient()
->method('get')
->addPath(['self-service-profiles'])
->withParams($parameters)
->withOptions($options)
->call();
}

public function getCustomTextForProfile(
string $id,
string $language,
string $page,
?RequestOptions $options = null,
): ResponseInterface {
[$id] = Toolkit::filter([$id])->string()->trim();
[$language] = Toolkit::filter([$language])->string()->trim();
[$page] = Toolkit::filter([$page])->string()->trim();

Toolkit::assert([
[$id, \Auth0\SDK\Exception\ArgumentException::missing('id')],
[$language, \Auth0\SDK\Exception\ArgumentException::missing('language')],
[$page, \Auth0\SDK\Exception\ArgumentException::missing('page')],
])->isString();

return $this->getHttpClient()
->method('get')
->addPath(['self-service-profiles', $id, 'custom-text', $language, $page])
->withOptions($options)
->call();
}

public function revokeSsoTicket(
string $profileId,
string $id,
?RequestOptions $options = null,
): ResponseInterface {
[$profileId, $id] = Toolkit::filter([$profileId, $id])->string()->trim();

Toolkit::assert([
[$profileId, \Auth0\SDK\Exception\ArgumentException::missing('profileId')],
[$id, \Auth0\SDK\Exception\ArgumentException::missing('id')],
])->isString();

return $this->getHttpClient()
->method('post')
->addPath(['self-service-profiles', $profileId, 'sso-ticket', $id, 'revoke'])
->withOptions($options)
->call();
}

public function setCustomTextForProfile(
string $id,
string $language,
string $page,
array $body,
?RequestOptions $options = null,
): ResponseInterface {
[$id] = Toolkit::filter([$id])->string()->trim();
[$language] = Toolkit::filter([$language])->string()->trim();
[$page] = Toolkit::filter([$page])->string()->trim();
[$body] = Toolkit::filter([$body])->array()->trim();

Toolkit::assert([
[$id, \Auth0\SDK\Exception\ArgumentException::missing('id')],
[$language, \Auth0\SDK\Exception\ArgumentException::missing('language')],
[$page, \Auth0\SDK\Exception\ArgumentException::missing('page')],
])->isString();

return $this->getHttpClient()
->method('put')
->addPath(['self-service-profiles', $id, 'custom-text', $language, $page])
->withOptions($options)
->withBody($body)
->call();
}

public function update(
string $id,
array $body,
?RequestOptions $options = null,
): ResponseInterface {
[$id] = Toolkit::filter([$id])->string()->trim();
[$body] = Toolkit::filter([$body])->array()->trim();

Toolkit::assert([
[$id, \Auth0\SDK\Exception\ArgumentException::missing('id')],
])->isString();

Toolkit::assert([
[$body, \Auth0\SDK\Exception\ArgumentException::missing('body')],
])->isArray();

return $this->getHttpClient()
->method('patch')
->addPath(['self-service-profiles', $id])
->withBody((object) $body)
->withOptions($options)
->call();
}
}
Loading