---
updatedAt: 2026-06-12T18:48:09.000Z
agentTools:
  projectIndex: https://docs.strivacity.com/llms.txt
---

# Create a social login provider

You can create a social login provider by calling this endpoint.

| REQUIRED API PERMISSION |
|:------------------------|
| write:config_login_provider |


# OpenAPI definition

```json
{
  "openapi": "3.0.1",
  "info": {
    "description": "API documentation of Admin Portal",
    "title": "Admin Portal",
    "version": "v0.0.1"
  },
  "servers": [
    {
      "url": "https://{tenant}",
      "variables": {
        "tenant": {
          "default": "example.strivacity.com",
          "description": "Your Strivacity tenant"
        }
      }
    }
  ],
  "tags": [
    {
      "name": "Social Login Provider"
    }
  ],
  "paths": {
    "/admin/api/v1/loginProviders/social": {
      "post": {
        "description": "You can create a social login provider by calling this endpoint.\n\n| REQUIRED API PERMISSION |\n|:------------------------|\n| write:config_login_provider |\n",
        "operationId": "createLoginProvider",
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/Generic_SocialLoginProvider_InsertRequest"
              }
            }
          },
          "required": true
        },
        "responses": {
          "201": {
            "content": {
              "*/*": {
                "schema": {
                  "$ref": "#/components/schemas/GenericSocialLoginProviderResponse"
                }
              }
            },
            "description": "Created"
          },
          "400": {
            "content": {
              "*/*": {
                "schema": {
                  "$ref": "#/components/schemas/ProblemJson"
                }
              }
            },
            "description": "Bad Request"
          },
          "401": {
            "content": {
              "application/problem+json": {
                "schema": {
                  "$ref": "#/components/schemas/ProblemJson"
                }
              }
            },
            "description": "Unauthorized"
          },
          "403": {
            "content": {
              "application/problem+json": {
                "schema": {
                  "$ref": "#/components/schemas/ProblemJson"
                }
              }
            },
            "description": "Forbidden"
          },
          "409": {
            "content": {
              "*/*": {
                "schema": {
                  "$ref": "#/components/schemas/ProblemJson"
                }
              }
            },
            "description": "Conflict"
          }
        },
        "security": [
          {
            "securityScheme": [
              "write:config_login_provider"
            ]
          }
        ],
        "summary": "Create a social login provider",
        "tags": [
          "Social Login Provider"
        ]
      }
    }
  },
  "components": {
    "schemas": {
      "AdditionalAuthRequestParam": {
        "type": "object",
        "properties": {
          "key": {
            "type": "string"
          },
          "value": {
            "type": "string"
          }
        }
      },
      "AdditionalAuthRequestParamUpsertRequest": {
        "required": [
          "key",
          "value"
        ],
        "type": "object",
        "properties": {
          "key": {
            "maxLength": 128,
            "minLength": 1,
            "pattern": "^\\p{ASCII}*$",
            "type": "string"
          },
          "value": {
            "maxLength": 1024,
            "minLength": 1,
            "pattern": "^\\p{ASCII}*$",
            "type": "string"
          }
        }
      },
      "AppleLoginProviderConfiguration": {
        "type": "object",
        "properties": {
          "additionalAuthRequestParams": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/AdditionalAuthRequestParam"
            }
          },
          "claims": {
            "type": "array",
            "items": {
              "type": "string"
            }
          },
          "clientId": {
            "type": "string"
          },
          "keyId": {
            "type": "string"
          },
          "signingKey": {
            "type": "string"
          },
          "teamId": {
            "type": "string"
          }
        }
      },
      "AppleLoginProviderRequestConfiguration": {
        "required": [
          "claims",
          "clientId",
          "keyId",
          "signingKey",
          "teamId"
        ],
        "type": "object",
        "properties": {
          "additionalAuthRequestParams": {
            "maxItems": 8,
            "minItems": 0,
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/AdditionalAuthRequestParamUpsertRequest"
            }
          },
          "claims": {
            "type": "array",
            "items": {
              "minLength": 1,
              "type": "string"
            }
          },
          "clientId": {
            "maxLength": 128,
            "minLength": 1,
            "type": "string"
          },
          "keyId": {
            "maxLength": 256,
            "minLength": 1,
            "type": "string"
          },
          "signingKey": {
            "maxLength": 2048,
            "minLength": 50,
            "type": "string"
          },
          "teamId": {
            "maxLength": 256,
            "minLength": 1,
            "type": "string"
          }
        }
      },
      "AppleLoginProviderResponse": {
        "type": "object",
        "properties": {
          "configuration": {
            "$ref": "#/components/schemas/AppleLoginProviderConfiguration"
          },
          "description": {
            "type": "string"
          },
          "id": {
            "type": "string"
          },
          "languageOverride": {
            "$ref": "#/components/schemas/LanguageOverrideResponse"
          },
          "loginButtonText": {
            "type": "string"
          },
          "name": {
            "type": "string"
          },
          "onlyStoreMappedValues": {
            "type": "boolean"
          },
          "policyTag": {
            "type": "string"
          },
          "type": {
            "type": "string",
            "enum": [
              "oidc",
              "okta",
              "azure",
              "hypr",
              "saml2",
              "github",
              "microsoft",
              "google",
              "facebook",
              "twitter",
              "linkedin",
              "amazon",
              "apple"
            ]
          },
          "updateAccountInfoOnLogin": {
            "type": "boolean"
          }
        }
      },
      "Apple_LoginProvider_InsertRequest": {
        "required": [
          "configuration",
          "name",
          "type"
        ],
        "type": "object",
        "properties": {
          "configuration": {
            "$ref": "#/components/schemas/AppleLoginProviderRequestConfiguration"
          },
          "description": {
            "maxLength": 1024,
            "minLength": 0,
            "type": "string"
          },
          "languageOverride": {
            "$ref": "#/components/schemas/LanguageOverride"
          },
          "loginButtonText": {
            "maxLength": 32,
            "minLength": 1,
            "pattern": "^((?![<>]).)*$",
            "type": "string"
          },
          "name": {
            "maxLength": 64,
            "minLength": 2,
            "pattern": "[a-zA-Z0-9]+",
            "type": "string",
            "description": "This field cannot be altered"
          },
          "onlyStoreMappedValues": {
            "type": "boolean",
            "default": false
          },
          "policyTag": {
            "pattern": "^[a-z0-9_]{2,32}$",
            "type": "string",
            "description": "Must be an existing policy tag name"
          },
          "type": {
            "type": "string",
            "description": "This field cannot be altered",
            "enum": [
              "oidc",
              "okta",
              "azure",
              "hypr",
              "saml2",
              "github",
              "microsoft",
              "google",
              "facebook",
              "twitter",
              "linkedin",
              "amazon",
              "apple"
            ]
          },
          "updateAccountInfoOnLogin": {
            "type": "boolean",
            "default": false
          }
        }
      },
      "FieldError": {
        "type": "object",
        "properties": {
          "field": {
            "type": "string"
          },
          "message": {
            "type": "string"
          },
          "objectName": {
            "type": "string"
          }
        }
      },
      "GenericSocialLoginProviderResponse": {
        "type": "object",
        "description": "Represents a social login provider.",
        "oneOf": [
          {
            "$ref": "#/components/schemas/AppleLoginProviderResponse"
          },
          {
            "$ref": "#/components/schemas/SocialLoginProviderResponse"
          }
        ]
      },
      "Generic_SocialLoginProvider_InsertRequest": {
        "type": "object",
        "description": "Represents a social login provider.",
        "oneOf": [
          {
            "$ref": "#/components/schemas/Apple_LoginProvider_InsertRequest"
          },
          {
            "$ref": "#/components/schemas/SocialLoginProvider_InsertRequest"
          }
        ]
      },
      "LanguageOverride": {
        "type": "object",
        "properties": {
          "enabled": {
            "type": "boolean",
            "default": false
          },
          "regex": {
            "maxLength": 64,
            "minLength": 0,
            "type": "string"
          },
          "sourcePath": {
            "maxLength": 256,
            "minLength": 0,
            "type": "string"
          }
        }
      },
      "LanguageOverrideResponse": {
        "type": "object",
        "properties": {
          "enabled": {
            "type": "boolean"
          },
          "regex": {
            "type": "string"
          },
          "sourcePath": {
            "type": "string"
          }
        }
      },
      "ProblemJson": {
        "type": "object",
        "properties": {
          "detail": {
            "type": "string"
          },
          "entityName": {
            "type": "string",
            "description": "The name of the entity within the error has occurred"
          },
          "errorKey": {
            "type": "string",
            "description": "A unique identifier of the error"
          },
          "fieldErrors": {
            "type": "array",
            "description": "Field constraint violation errors",
            "items": {
              "$ref": "#/components/schemas/FieldError"
            }
          },
          "message": {
            "type": "string",
            "description": "A unique identifier in format of 'error.{errorKey}'"
          },
          "params": {
            "type": "array",
            "description": "Further information related to the actual error",
            "items": {
              "type": "object",
              "additionalProperties": {
                "type": "object"
              }
            }
          },
          "path": {
            "type": "string",
            "description": "Request URI"
          },
          "status": {
            "type": "integer",
            "description": "Status code",
            "format": "int32"
          },
          "title": {
            "type": "string"
          }
        },
        "description": "Based on [RFC 7807](https://datatracker.ietf.org/doc/html/rfc7807)"
      },
      "SocialLoginProviderConfiguration": {
        "type": "object",
        "properties": {
          "additionalAuthRequestParams": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/AdditionalAuthRequestParam"
            }
          },
          "claims": {
            "type": "array",
            "items": {
              "type": "string"
            }
          },
          "clientId": {
            "type": "string"
          },
          "clientSecret": {
            "type": "string"
          }
        }
      },
      "SocialLoginProviderRequestConfiguration": {
        "required": [
          "claims",
          "clientId",
          "clientSecret"
        ],
        "type": "object",
        "properties": {
          "additionalAuthRequestParams": {
            "maxItems": 8,
            "minItems": 0,
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/AdditionalAuthRequestParamUpsertRequest"
            }
          },
          "claims": {
            "type": "array",
            "items": {
              "minLength": 1,
              "type": "string"
            }
          },
          "clientId": {
            "maxLength": 128,
            "minLength": 1,
            "type": "string"
          },
          "clientSecret": {
            "maxLength": 1024,
            "minLength": 1,
            "type": "string"
          }
        }
      },
      "SocialLoginProviderResponse": {
        "type": "object",
        "properties": {
          "configuration": {
            "$ref": "#/components/schemas/SocialLoginProviderConfiguration"
          },
          "description": {
            "type": "string"
          },
          "id": {
            "type": "string"
          },
          "languageOverride": {
            "$ref": "#/components/schemas/LanguageOverrideResponse"
          },
          "loginButtonText": {
            "type": "string"
          },
          "name": {
            "type": "string"
          },
          "onlyStoreMappedValues": {
            "type": "boolean"
          },
          "policyTag": {
            "type": "string"
          },
          "type": {
            "type": "string",
            "enum": [
              "oidc",
              "okta",
              "azure",
              "hypr",
              "saml2",
              "github",
              "microsoft",
              "google",
              "facebook",
              "twitter",
              "linkedin",
              "amazon",
              "apple"
            ]
          },
          "updateAccountInfoOnLogin": {
            "type": "boolean"
          }
        }
      },
      "SocialLoginProvider_InsertRequest": {
        "required": [
          "configuration",
          "name",
          "type"
        ],
        "type": "object",
        "properties": {
          "configuration": {
            "$ref": "#/components/schemas/SocialLoginProviderRequestConfiguration"
          },
          "description": {
            "maxLength": 1024,
            "minLength": 0,
            "type": "string"
          },
          "languageOverride": {
            "$ref": "#/components/schemas/LanguageOverride"
          },
          "loginButtonText": {
            "maxLength": 32,
            "minLength": 1,
            "pattern": "^((?![<>]).)*$",
            "type": "string"
          },
          "name": {
            "maxLength": 64,
            "minLength": 2,
            "pattern": "[a-zA-Z0-9]+",
            "type": "string",
            "description": "This field cannot be altered"
          },
          "onlyStoreMappedValues": {
            "type": "boolean",
            "default": false
          },
          "policyTag": {
            "pattern": "^[a-z0-9_]{2,32}$",
            "type": "string",
            "description": "Must be an existing policy tag name"
          },
          "type": {
            "type": "string",
            "description": "This field cannot be altered",
            "enum": [
              "oidc",
              "okta",
              "azure",
              "hypr",
              "saml2",
              "github",
              "microsoft",
              "google",
              "facebook",
              "twitter",
              "linkedin",
              "amazon",
              "apple"
            ]
          },
          "updateAccountInfoOnLogin": {
            "type": "boolean",
            "default": false
          }
        }
      }
    },
    "securitySchemes": {
      "securityScheme": {
        "scheme": "bearer",
        "type": "http"
      }
    }
  }
}
```