IdentityProviderService · IdentityProviderService_CreateIdentityProvider
Protocol-derived reference. Authorization and instance policy still apply. Schema descriptions are inherited from the MIT-licensed application contract; examples here are not executed against a live server.
Access
Requires an instance administrator. A normal authenticated account cannot perform this operation.
Request
CreateIdentityProvider creates an identity provider.
POST
/api/v1/identity-providersParameters
| Name / location | Type / requirement | Description |
|---|---|---|
identityProviderIdquery | string Not marked required in OpenAPI | Optional. The ID to use for the identity provider, which will become the final component of the resource name. If not provided, the system will generate one. Format: ^[a-zA-Z0-9]([a-zA-Z0-9-]{0,34}[a-zA-Z0-9])?$ |
Request body
Required
application/json · IdentityProvider
Responses
200 · OK
application/json · IdentityProvider
default · Default error response
application/json · Status
Complete operation definition
All declared constraints, media types and response details are retained below. Schema references link to their complete definitions.
Open JSON definition
{
"tags": [
"IdentityProviderService"
],
"description": "CreateIdentityProvider creates an identity provider.",
"operationId": "IdentityProviderService_CreateIdentityProvider",
"parameters": [
{
"name": "identityProviderId",
"in": "query",
"description": "Optional. The ID to use for the identity provider, which will become the final component of the resource name.\n If not provided, the system will generate one.\n Format: ^[a-zA-Z0-9]([a-zA-Z0-9-]{0,34}[a-zA-Z0-9])?$",
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IdentityProvider"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IdentityProvider"
}
}
}
},
"default": {
"description": "Default error response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Status"
}
}
}
}
}
}