Update a self-service profile

Updates a self-service profile.

PATCH https://{tenantDomain}/api/v2/self-service-profiles/{id}

C#

C#

using Auth0.ManagementApi;
using System.Threading.Tasks;

public partial class Examples
{
    public async Task Example() {
        var client = new ManagementApiClient(
            token: "<token>",
            clientOptions: new ClientOptions { BaseUrl = "https://{YOUR_DOMAIN}/api/v2" }
        );

        await client.SelfServiceProfiles.UpdateAsync(
            id: "id",
            request: new UpdateSelfServiceProfileRequestContent()
        );
    }

}

package example

import (
    context "context"

    management "github.com/auth0/go-auth0/v2/management"
    client "github.com/auth0/go-auth0/v2/management/client"
    option "github.com/auth0/go-auth0/v2/management/option"
)

func do() {
    mgmt, err := client.New(
        "{YOUR_DOMAIN}",
        option.WithToken(
            "<token>",
        ),
    )
    if err != nil {
        return
    }
    request := &management.UpdateSelfServiceProfileRequestContent{}
    mgmt.SelfServiceProfiles.Update(
        context.TODO(),
        "id",
        request,
    )
}

package com.example.usage;

import com.auth0.client.mgmt.ManagementApi;
import com.auth0.client.mgmt.types.UpdateSelfServiceProfileRequestContent;

public class Example {
    public static void main(String[] args) {
        ManagementApi client = ManagementApi
            .builder()
            .domain("{YOUR_DOMAIN}")
            .token("<token>")
            .build();

        client.selfServiceProfiles().update(
            "id",
            UpdateSelfServiceProfileRequestContent
                .builder()
                .build()
        );
    }
}

<?php

namespace Example;

use Auth0\SDK\API\Management\Wrapper\ManagementClient;
use Auth0\SDK\API\Management\Wrapper\ManagementClientOptions;
use Auth0\SDK\API\Management\SelfServiceProfiles\Requests\UpdateSelfServiceProfileRequestContent;

$client = new ManagementClient(new ManagementClientOptions(
    domain: '{YOUR_DOMAIN}',
    token: '<token>',
));
$client->selfServiceProfiles->update(
    'id',
    new UpdateSelfServiceProfileRequestContent([]),
);

from auth0.management import ManagementClient

client = ManagementClient(
    domain="{YOUR_DOMAIN}",
    token="<token>",
)

client.self_service_profiles.update(
    id="id",
)

require "auth0"

client = Auth0::Management.new(token: "<token>", base_url: "https://{YOUR_DOMAIN}/api/v2")

client.self_service_profiles.update(id: "id")

import { ManagementClient } from "auth0";

async function main() {
    const client = new ManagementClient({
        domain: "{YOUR_DOMAIN}",
        token: "<token>",
    });
    await client.selfServiceProfiles.update("id", {});
}
main();

import { ManagementClient } from "auth0";

async function main() {
    const client = new ManagementClient({
        domain: "{YOUR_DOMAIN}",
        token: "<token>",
    });
    await client.selfServiceProfiles.update("id", {});
}
main();

curl --request PATCH \
  --url https://{tenantDomain}/api/v2/self-service-profiles/{id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "description": "<string>",
  "branding": {
    "logo_url": "<string>"
  },
  "allowed_strategies": [],
  "user_attributes": [
    {
      "name": "<string>",
      "description": "<string>",
      "is_optional": true
    }
  ],
  "user_attribute_profile_id": "<string>"
}
'

200

{
  "id": "ssp_n7SNCL8seoyV1TuSTCnAeo",
  "name": "<string>",
  "description": "<string>",
  "user_attributes": [
    {
      "name": "<string>",
      "description": "<string>",
      "is_optional": true
    }
  ],
  "created_at": "2021-01-01T00:00:00.000Z",
  "updated_at": "2021-01-01T00:00:00.000Z",
  "branding": {
    "logo_url": "<string>",
    "colors": {
      "primary": "<string>"
    }
  },
  "allowed_strategies": [],
  "user_attribute_profile_id": "<string>"
}

Authorizations

bearerAuthoAuth2ClientCredentials

Authorization · string · header · required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

id · string · required

The id of the self-service profile to update

Body

application/jsonapplication/x-www-form-urlencoded

name · string

The name of the self-service Profile.

Required string length: 1 - 100

description · string | null

The description of the self-service Profile.

Required string length: 1 - 140

branding · object | null

Show child attributes

allowed_strategies · enum<string>[]

List of IdP strategies that will be shown to users during the Self-Service Enterprise Configuration flow. Possible values: [oidc, samlp, waad, google-apps, adfs, okta, auth0-samlp, okta-samlp, keycloak-samlp, pingfederate]

Minimum array length: 1

Available options: oidc, samlp, waad, google-apps, adfs, okta, auth0-samlp, okta-samlp, keycloak-samlp, pingfederate

user_attributes · object[] | null

List of attributes to be mapped that will be shown to the user during the Self-Service Enterprise Configuration flow.

Show child attributes

user_attribute_profile_id · string<user-attribute-profile-id> | null · EA

ID of the user-attribute-profile to associate with this self-service profile.

Response

200

application/json

Self-service profile successfully updated.

id · string · default: ssp_n7SNCL8seoyV1TuSTCnAeo

The unique ID of the self-service Profile.

name · string

The name of the self-service Profile.

description · string

The description of the self-service Profile.

user_attributes · object[]

List of attributes to be mapped that will be shown to the user during the Self-Service Enterprise Configuration flow.

Show child attributes

created_at · string<date-time> · default: 2021-01-01T00:00:00.000Z

The time when this self-service Profile was created.

updated_at · string<date-time> · default: 2021-01-01T00:00:00.000Z

The time when this self-service Profile was updated.

branding · object

Show child attributes

allowed_strategies · enum<string>[]

List of IdP strategies that will be shown to users during the Self-Service Enterprise Configuration flow. Possible values: [oidc, samlp, waad, google-apps, adfs, okta, auth0-samlp, okta-samlp, keycloak-samlp, pingfederate]

Minimum array length: 1

Available options: oidc, samlp, waad, google-apps, adfs, okta, auth0-samlp, okta-samlp, keycloak-samlp, pingfederate

user_attribute_profile_id · string<user-attribute-profile-id> · EA

ID of the user-attribute-profile to associate with this self-service profile.