mirror of
https://github.com/forcedotcom/afv-library.git
synced 2026-08-05 14:54:50 +08:00
109 lines
8.2 KiB
JSON
109 lines
8.2 KiB
JSON
{
|
||
"sections": [
|
||
"title",
|
||
"description",
|
||
"supported_soap_calls",
|
||
"supported_rest_api_http_methods",
|
||
"fields",
|
||
"sub_types",
|
||
"special_access_rules",
|
||
"wsdl_segment"
|
||
],
|
||
"title": "ExternalAuthIdentityProvider - Tooling API",
|
||
"description": "Represents an external authentication (auth) identity provider. An external auth identity provider links to an external credential and obtains OAuth tokens for outbound callouts to external systems.",
|
||
"supported_soap_calls": "`create()`, `delete()`, `describeSObjects()`, `query()`, `retrieve()`, `update()`, `upsert()`",
|
||
"supported_rest_api_http_methods": "`DELETE`, `GET`, `HEAD`, `PATCH`, `POST`, `Query`",
|
||
"fields_columns": [
|
||
"type",
|
||
"properties",
|
||
"description"
|
||
],
|
||
"fields": {
|
||
"AuthenticationFlow": {
|
||
"type": "picklist",
|
||
"properties": "Filter, Group, Restricted picklist, Sort",
|
||
"description": "Authentication flow to get tokens to call protected APIs. Possible values are: AuthorizationCode ClientCredentials SalesforceDefined"
|
||
},
|
||
"AuthenticationProtocol": {
|
||
"type": "picklist",
|
||
"properties": "Filter, Group, Restricted picklist, Sort",
|
||
"description": "The authentication protocol that’s required to access the external system. Possible values are: OAuth SalesforceDefined"
|
||
},
|
||
"Description": {
|
||
"type": "string",
|
||
"properties": "Filter, Group, Nillable, Sort",
|
||
"description": "A meaningful description of the external auth identity provider."
|
||
},
|
||
"DeveloperName": {
|
||
"type": "string",
|
||
"properties": "Filter, Group, Sort",
|
||
"description": "The unique internal name for the named credential used in the API. This name can contain only underscores and alphanumeric characters, and must be unique in your org. It must begin with a letter, not include spaces, not end with an underscore, and not contain two consecutive underscores. This field is automatically generated, but you can supply your own value if you create the record using the API. Note: When creating large sets of data, always specify a unique DeveloperName for each record. If no DeveloperName is specified, performance may slow while Salesforce generates one for each record. Note: Only users with View DeveloperName OR View Setup and Configuration permission can view, group, sort, and filter this field."
|
||
},
|
||
"FullName": {
|
||
"type": "string",
|
||
"properties": "Create, Group, Nillable",
|
||
"description": "The full name of the associated type in Tooling API. The full name can include a namespace prefix. Query this field only if the query result contains no more than one record. Otherwise, an error is returned. If more than one record exists, use multiple queries to retrieve the records. This limit protects performance."
|
||
},
|
||
"Language": {
|
||
"type": "picklist",
|
||
"properties": "Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort",
|
||
"description": "The language of the external auth identity provider."
|
||
},
|
||
"ManageableState": {
|
||
"type": "ManageableState enumerated list",
|
||
"properties": "Filter, Group, Nillable, Restricted picklist, Sort",
|
||
"description": "Indicates the manageable state of the specified component that is contained in a package: beta deleted deprecated deprecatedEditable installed installedEditable released unmanaged"
|
||
},
|
||
"MasterLabel": {
|
||
"type": "string",
|
||
"properties": "Filter, Group, Sort",
|
||
"description": "Label for the external auth identity provider. In the UI, this field is Label."
|
||
},
|
||
"Metadata": {
|
||
"type": "complexvalue",
|
||
"properties": "Create, Nillable, Update",
|
||
"description": "Provides access to the associated metadata type and related fields in Tooling API. Query this field only if the query result contains no more than one record. Otherwise, an error is returned. If more than one record exists, use multiple queries to retrieve the records. This limit protects performance."
|
||
},
|
||
"NamespacePrefix": {
|
||
"type": "string",
|
||
"properties": "Filter, Group, Nillable, Sort",
|
||
"description": "The namespace prefix that is associated with this object. Each Developer Edition org that creates a managed package has a unique namespace prefix. Limit: 15 characters. You can refer to a component in a managed package by using the namespacePrefix__componentName notation."
|
||
}
|
||
},
|
||
"sub_types": {
|
||
"ExternalAuthIdentityProviderParameter": {
|
||
"Description": {
|
||
"type": "string",
|
||
"properties": "Filter, Group, Nillable, Sort",
|
||
"description": "A human-readable description of the external auth identity provider parameter."
|
||
},
|
||
"ManageableState": {
|
||
"type": "ManageableState enumerated list",
|
||
"properties": "Filter, Group, Nillable, Restricted picklist, Sort",
|
||
"description": "Indicates the manageable state of the specified component that is contained in a package: beta deleted deprecated deprecatedEditable installed installedEditable released unmanaged"
|
||
},
|
||
"ParameterName": {
|
||
"type": "string",
|
||
"properties": "Filter, Group, Sort",
|
||
"description": "The name of the external auth identity provider parameter."
|
||
},
|
||
"ParameterType": {
|
||
"type": "picklist",
|
||
"properties": "Filter, Group, Restricted picklist, Sort",
|
||
"description": "The type of external auth identity provider parameter. The value of this field drives the behavior of the parameter. Possible values are: AuthorizeRequestQueryParameter AuthorizeUrl ClientAuthentication CreatedByNamespace IdentityProviderOptions ManagedByComponent ManagedByFeature RefreshRequestBodyParameter RefreshRequestHttpHeader RefreshRequestQueryParameter StandardExternalIdentityProvider TokenRequestBodyParameter TokenRequestHttpHeader TokenRequestQueryParameter TokenUrl UserInfoUrl"
|
||
},
|
||
"ParameterValue": {
|
||
"type": "textarea",
|
||
"properties": "Nillable",
|
||
"description": "If the parameterType field describes a literal value then the literal value is stored in this field."
|
||
},
|
||
"SequenceNumber": {
|
||
"type": "int",
|
||
"properties": "Filter, Group, Nillable, Sort",
|
||
"description": "Specifies the order of parameters to apply when an external auth identity provider has more than one parameter. Priority is from lower to higher numbers (for example, 1 is the highest priority)."
|
||
}
|
||
}
|
||
},
|
||
"special_access_rules": "Only users with the Customize Application permission or the Manage Named Credentials permission can access this object.",
|
||
"wsdl_segment": "```xml\n<xsd:complexType name=\"ExternalAuthIdentityProvider\">\n <xsd:complexContent>\n <xsd:extension base=\"ens:sObject\">\n <xsd:sequence>\n <xsd:element name=\"FullName\" minOccurs=\"0\" type=\"xsd:string\" nillable=\"true\"/>\n <xsd:element name=\"Metadata\" minOccurs=\"0\" type=\"mns:ExternalAuthIdentityProvider\" nillable=\"true\"/>\n </xsd:sequence>\n </xsd:extension>\n </xsd:complexContent>\n</xsd:complexType>\n\n\n<xsd:complexType name=\"ExternalAuthIdentityProvider\">\n <xsd:complexContent>\n <xsd:extension base=\"mns:Metadata\">\n <xsd:sequence>\n <xsd:element name=\"authenticationFlow\" type=\"tns:IdentityProviderAuthFlow\"/>\n <xsd:element name=\"authenticationProtocol\" type=\"tns:IdentityProviderAuthProtocol\"/>\n <xsd:element name=\"description\" minOccurs=\"0\" type=\"xsd:string\"/>\n <xsd:element name=\"externalAuthIdentityProviderParameters\" minOccurs=\"0\" maxOccurs=\"unbounded\" type=\"mns:ExternalAuthIdentityProviderParameter\"/>\n <xsd:element name=\"label\" type=\"xsd:string\"/>\n </xsd:sequence>\n </xsd:extension>\n </xsd:complexContent>\n</xsd:complexType>\n<xsd:simpleType name=\"IdentityProviderAuthFlow\">\n <xsd:restriction base=\"xsd:string\">\n <xsd:enumeration value=\"AuthorizationCode\"/>\n <xsd:enumeration value=\"ClientCredentials\"/>\n <xsd:enumeration value=\"SalesforceDefined\"/>\n </xsd:restriction>\n</xsd:simpleType>\n<xsd:simpleType name=\"IdentityProviderAuthProtocol\">\n <xsd:restriction base=\"xsd:string\">\n <xsd:enumeration value=\"OAuth\"/>\n <xsd:enumeration value=\"SalesforceDefined\"/>\n </xsd:restriction>\n</xsd:simpleType>\n```"
|
||
} |