BEbeyondidentity
Applications

Create a New Application

Changed on

To create an application, send a POST request to /v1/tenants/$TENANT_ID/realms/$REALM_ID/applications. Values in the request body for read-only fields will be ignored. At present, there are only two supported protocol types for applications, oauth2 and oidc.

post/v1/tenants/{tenant_id}/realms/{realm_id}/applications

Request

Path parameters

tenant_idstring required
Example:000176d94fd7b4d1

A unique identifier for a tenant.

realm_idstring required
Example:19a95130480dfa79

A unique identifier for a realm.

Request body

Example request

{
  "application": {
    "id": "38833c36-6f47-4992-9329-ea0a00915137",
    "realm_id": "caf2ff640497591a",
    "tenant_id": "00011f1183c67b69",
    "resource_server_id": "84db69f5-48a8-4c11-8cda-1bae3a73f07e",
    "authenticator_config_id": "73731b7f-eb76-4143-9b4b-81a720385f5a",
    "display_name": "Pet Application",
    "protocol_config": {
      "allowed_scopes": [
        "pets:read"
      ],
      "client_id": "AYYNcuOSpfqIf33JeegCzDIT",
      "client_secret": "wWD4mPzdsjms1LPekQSo0v9scOHLWy5wmMtKAR2JNhJPAKXv",
      "confidentiality": "confidential",
      "token_endpoint_auth_method": "client_secret_basic",
      "grant_type": [
        "authorization_code"
      ],
      "redirect_uris": [
        "https://auth.mypetapp.com/callback"
      ],
      "token_configuration": {
        "expires_after": 86400,
        "token_signing_algorithm": "RS256",
        "subject_field": "id"
      },
      "pkce": "s256",
      "token_format": "self_contained"
    }
  }
}

Response

The response will be a JSON object containing the standard attributes associated with an application.

idstring

A unique identifier for an application. This is automatically generated on creation. This field is immutable and read-only. This field is unique within the realm.

realm_idstring

A unique identifier for the application's realm. This is automatically set on creation. This field is immutable and read-only.

tenant_idstring

A unique identifier for the application's tenant. This is automatically set on creation. This field is immutable and read-only.

resource_server_idstring

A unique identifier for the application's resource server. At present, the only available resource server is for the Beyond Identity Management API. Referencing this resource server from an application will allow that application to grant access to Beyond Identity's APIs. When not present, this application may provide authentication (identity) but not authorization (access).

authenticator_config_idstring

A unique identifier for the application's authenticator configuration. This field is unused for oidc and oauth2 applications when grant_type=client_credentials.

display_namestring

A human-readable name for the application. This name is used for display purposes.

is_managedboolean

A boolean indicating whether the application is managed by Beyond Identity. Managed applications may not be modified by the user. This is automatically set on creation. This field is immutable and read-only.

Example response

{
  "id": "38833c36-6f47-4992-9329-ea0a00915137",
  "realm_id": "caf2ff640497591a",
  "tenant_id": "00011f1183c67b69",
  "resource_server_id": "84db69f5-48a8-4c11-8cda-1bae3a73f07e",
  "authenticator_config_id": "73731b7f-eb76-4143-9b4b-81a720385f5a",
  "display_name": "Pet Application",
  "protocol_config": {
    "allowed_scopes": [
      "pets:read"
    ],
    "client_id": "AYYNcuOSpfqIf33JeegCzDIT",
    "client_secret": "wWD4mPzdsjms1LPekQSo0v9scOHLWy5wmMtKAR2JNhJPAKXv",
    "confidentiality": "confidential",
    "token_endpoint_auth_method": "client_secret_basic",
    "grant_type": [
      "authorization_code"
    ],
    "redirect_uris": [
      "https://auth.mypetapp.com/callback"
    ],
    "token_configuration": {
      "expires_after": 86400,
      "token_signing_algorithm": "RS256",
      "subject_field": "id"
    },
    "pkce": "s256",
    "token_format": "self_contained"
  }
}

Changes

  • 42f3cac49392Revision changes
    • info

      added the new optional request property //////

    • info

      added the optional property ///// to the response with the status