_oauth-idp-operations.mdx

import API from 'src/components/api/API.astro'; import InlineField from 'src/components/InlineField.astro'; import OauthIdpRequestBody from 'src/content/docs/apis/identity-providers/_oauth-idp-request-body.mdx'; import StandardPostResponseCodes from 'src/content/docs/apis/_standard-post-response-codes.astro'; import OauthIdpResponseBody from 'src/content/docs/apis/identity-providers/_oauth-idp-response-body.mdx'; import StandardGetResponseCodes from 'src/content/docs/apis/_standard-get-response-codes.astro'; import GenericUpdateExplanationFragment from 'src/content/docs/apis/_generic-update-explanation-fragment.mdx'; import StandardPutResponseCodes from 'src/content/docs/apis/_standard-put-response-codes.astro'; import StandardDeleteResponseCodes from 'src/content/docs/apis/_standard-delete-response-codes.astro'; import CompleteLoginText from 'src/content/docs/apis/identity-providers/_complete-login-text.mdx'; import APIBlock from 'src/components/api/APIBlock.astro'; import XForwardedForHeader from 'src/content/docs/apis/identity-providers/_x-forwarded-for-header.mdx'; import XFusionauthTenantIdHeaderScopedOperationRowOnly from 'src/content/docs/apis/_x-fusionauth-tenant-id-header-scoped-operation-row-only.mdx'; import IdentityProviderLoginRequestBody from 'src/content/docs/apis/identity-providers/_identity-provider-login-request-body.astro'; import IdentityProviderLoginResponseBody from 'src/content/docs/apis/identity-providers/_identity-provider-login-response-body.mdx';

Create the {props.manual_idp_display_name} Identity Provider

Request

<API method="POST" uri="/api/identity-provider" authentication={["api-key"]} title={Create the ${props.manual_idp_display_name} Identity Provider}/>

The type in the request JSON is used to determine that you are managing the {props.manual_idp_display_name} identity provider.

Response

Retrieve the {props.manual_idp_display_name} Identity Provider

There is only one {props.manual_idp_display_name} Identity Provider, so this Identity Provider may be retrieved by type or Id.

Request

<API method="GET" uri={/api/identity-provider?type=${props.idp_type}} authentication={["api-key"]} title={Retrieve the ${props.manual_idp_display_name} Identity Provider by type}/>

<API method="GET" uri={/api/identity-provider/${props.idp_id}} authentication={["api-key"]} title={Retrieve the ${props.manual_idp_display_name} Identity Provider by Id}/>

Response

Update the {props.manual_idp_display_name} Identity Provider

<GenericUpdateExplanationFragment extra_id_verbiage={There is only one ${props.manual_idp_display_name} Identity Provider, so this Identity Provider may be updated by type or Id.} capitalized_object_name={${props.manual_idp_display_name} Identity Provider} />

Request

<API method="PUT" uri={/api/identity-provider?type=${props.idp_type}} authentication={["api-key"]} showPatch={true} title={Update the ${props.manual_idp_display_name} Identity Provider by type}/>

<API method="PUT" uri={/api/identity-provider/${props.idp_id}} authentication={["api-key"]} showPatch={true} title={Update the ${props.manual_idp_display_name} Identity Provider by Id}/>

Response

The response for this API contains the {props.manual_idp_display_name} Identity Provider.

Delete the {props.manual_idp_display_name} Identity Provider

There is only one {props.manual_idp_display_name} Identity Provider, so this Identity Provider may be deleted by type or Id.

Request

<API method="DELETE" uri={/api/identity-provider?type=${props.idp_type}} authentication={["api-key"]} title={Delete the ${props.manual_idp_display_name} Identity Provider by type}/>

<API method="DELETE" uri={/api/identity-provider/${props.idp_id}} authentication={["api-key"]} title={Delete the ${props.manual_idp_display_name} Identity Provider by Id}/>

Response

This API does not return a JSON response body.

Complete the {props.manual_idp_display_name} Login

<CompleteLoginText idp_display_name={props.manual_idp_display_name} token_text_with_article={"a " + props.idp_token_or_code} token_text={props.idp_token_or_code} />

Request

<API method="POST" uri="/api/identity-provider/login" authentication={["none"]} title={Complete ${props.manual_idp_display_name} Login}/>

Request Headers

Response

The response for this API contains the User object.