REST Resource: customers.v2.ServiceProviderConfig

Recurso: ServiceProviderConfig

Da seção 5 da RFC 7643. O recurso de configuração do provedor de serviços permite que um provedor descubra recursos de especificação do SCIM de forma padronizada e forneça detalhes de implementação adicionais aos clientes.

Representação JSON
{
  "schemas": [
    string
  ],
  "authenticationSchemes": [
    {
      object (AuthenticationScheme)
    }
  ],
  "documentationUri": string,
  "patch": {
    object (PatchFeature)
  },
  "bulk": {
    object (BulkFeature)
  },
  "filter": {
    object (FilterFeature)
  },
  "changePassword": {
    object (ChangePasswordFeature)
  },
  "sort": {
    object (SortFeature)
  },
  "etag": {
    object (EtagFeature)
  },
  "meta": {
    object (Meta)
  }
}
Campos
schemas[]

string

Apenas saída. O atributo schemas contém URIs usados para indicar os namespaces dos esquemas SCIM que definem os atributos presentes na estrutura JSON atual.

authenticationSchemes[]

object (AuthenticationScheme)

Apenas saída. Um tipo complexo de vários valores que especifica os esquemas de autenticação aceitos.

documentationUri

string

Apenas saída. Um URL endereçável por HTTP que aponta para a documentação de ajuda do provedor de serviços, que pode ser consumida por humanos.

patch

object (PatchFeature)

Apenas saída. Um tipo complexo que especifica a compatibilidade com o recurso PATCH.

bulk

object (BulkFeature)

Apenas saída. Um tipo complexo que especifica a compatibilidade com operações em massa.

filter

object (FilterFeature)

Apenas saída. Um tipo complexo que especifica a compatibilidade com filtros.

changePassword

object (ChangePasswordFeature)

Apenas saída. Um tipo complexo que especifica o suporte para mudança de senha.

sort

object (SortFeature)

Apenas saída. Um tipo complexo que especifica a compatibilidade com classificação.

etag

object (EtagFeature)

Apenas saída. Um tipo complexo que especifica a compatibilidade com ETag.

meta

object (Meta)

Apenas saída. Metadados de recursos atribuídos pelo provedor de serviços.

PatchFeature

Um tipo complexo que especifica a compatibilidade com o recurso PATCH.

Representação JSON
{
  "supported": boolean
}
Campos
supported

boolean

Apenas saída. Especifica se a operação é compatível ou não.

BulkFeature

Um tipo complexo que especifica a compatibilidade com operações em massa.

Representação JSON
{
  "supported": boolean,
  "maxOperations": integer,
  "maxPayloadSize": integer
}
Campos
supported

boolean

Apenas saída. Especifica se a operação é compatível ou não.

maxOperations

integer

Apenas saída. Especifica o número máximo de operações.

maxPayloadSize

integer

Apenas saída. Especifica o tamanho máximo do payload em bytes.

FilterFeature

Um tipo complexo que especifica a compatibilidade com filtros.

Representação JSON
{
  "supported": boolean,
  "maxResults": integer
}
Campos
supported

boolean

Apenas saída. Especifica se a operação é compatível ou não.

maxResults

integer

Apenas saída. Especifica o número máximo de resultados.

ChangePasswordFeature

Um tipo complexo que especifica o suporte para mudança de senha.

Representação JSON
{
  "supported": boolean
}
Campos
supported

boolean

Apenas saída. Especifica se a operação é compatível ou não.

SortFeature

Um tipo complexo que especifica a compatibilidade com classificação.

Representação JSON
{
  "supported": boolean
}
Campos
supported

boolean

Apenas saída. Especifica se a operação é compatível ou não.

EtagFeature

Um tipo complexo que especifica a compatibilidade com ETag.

Representação JSON
{
  "supported": boolean
}
Campos
supported

boolean

Apenas saída. Especifica se a operação é compatível ou não.

AuthenticationScheme

Um tipo complexo de vários valores que especifica os esquemas de autenticação aceitos.

Representação JSON
{
  "type": string,
  "name": string,
  "description": string,
  "specUri": string,
  "documentationUri": string,
  "primary": boolean
}
Campos
type

string

Apenas saída. O tipo de esquema de autenticação.

name

string

Apenas saída. O nome do esquema de autenticação.

description

string

Apenas saída. Uma descrição do esquema de autenticação.

specUri

string

Apenas saída. Um URL endereçável por HTTP que aponta para a especificação do esquema de autenticação.

documentationUri

string

Apenas saída. Um URL endereçável por HTTP que aponta para a documentação do esquema de autenticação.

primary

boolean

Apenas saída. Indica o primary ou o esquema de autenticação preferido.

Métodos

get

Recupera a configuração do provedor de serviços.