Skip to main content

Add Domain

POST 
https://$CUSTOM-DOMAIN/management/v1/orgs/me/domains

Add a new domain to an organization. The domains are used to identify to which organization a user belongs.

Request​

Header Parameters

    x-zitadel-orgid string

    The default is always the organization of the requesting user. If you like to get/set a result of another organization include the header. Make sure the user has permission to access the requested data.

Body

required

    domain stringrequired

    Possible values: non-empty and <= 200 characters

Responses​

A successful response.

Schema

    details

    object

    sequence uint64

    on read: the sequence of the last event reduced by the projection

    on manipulation: the timestamp of the event(s) added by the manipulation

    creationDate date-time

    on read: the timestamp of the first event of the object

    on create: the timestamp of the event(s) added by the manipulation

    changeDate date-time

    on read: the timestamp of the last event reduced by the projection

    on manipulation: the

    resourceOwner resource_owner is the organization an object belongs to (string)
curl -L 'https://$CUSTOM-DOMAIN/management/v1/orgs/me/domains' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <TOKEN>' \
-d '{
  "domain": "testdomain.com"
}'
Request Collapse all
Base URL
https://$CUSTOM-DOMAIN/management/v1
Auth
Parameters
— header
Body required
{
  "domain": "testdomain.com"
}
ResponseClear

Click the Send API Request button above and see the response here!