Skip to main content

Create Application (SAML)

POST 
https://$CUSTOM-DOMAIN/management/v1/projects/:projectId/apps/saml

Create a new SAML client. Returns an entity ID

Request​

Path Parameters

    projectId stringrequired

Header Parameters

    x-zitadel-orgid string

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

Body

required

    name stringrequired

    Possible values: non-empty and <= 200 characters

    metadataXml byte
    metadataUrl string

    loginVersion

    object

    Specify the preferred login UI, where the user is redirected to for authentication. If unset, the login UI is chosen by the instance default.

    loginV1 object

    loginV2

    object

    baseUri string

    Optionally specify a base uri of the login UI. If unspecified the default URI will be used.

Responses​

A successful response.

Schema

    appId string

    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/projects/:projectId/apps/saml' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <TOKEN>' \
-d '{
  "name": "MySAMLApp",
  "metadataXml": "string",
  "metadataUrl": "string",
  "loginVersion": {
    "loginV1": {},
    "loginV2": {
      "baseUri": "string"
    }
  }
}'
Request Collapse all
Base URL
https://$CUSTOM-DOMAIN/management/v1
Auth
Parameters
— pathrequired
— header
Body required
{
  "name": "MySAMLApp",
  "metadataXml": "string",
  "metadataUrl": "string",
  "loginVersion": {
    "loginV1": {},
    "loginV2": {
      "baseUri": "string"
    }
  }
}
ResponseClear

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