createUser

Categoria	Modificação de metadados
Descrição	Crie um ou mais usuários. Se for bem-sucedida, a API retornará uma mensagem para o usuário que acabou de ser criado. Oferece suporte à criação de no máximo 1.000 usuários em uma única solicitação.
Permissões obrigatórias para invocar	Permissão de usuário
Parâmetros obrigatórios na solicitação	Credenciais

A solicitação desse método contém uma etiqueta de credenciais para identificar e autorizar o usuário que está fazendo a chamada. O usuário deve ter a permissão "Permissão de usuário" para criar os usuários.

Esse método não funciona após a sincronização de usuário do Workday.

Formato da solicitação


<?xml version='1.0' encoding='UTF-8'?>
<call method="createUser" callerName="a string that identifies your client application">
      <credentials login="sampleuser@company.com" password="my_pwd" />
        <users>
            <user
              email="newUser@company.com"
              name="new guy"
              password="new Password"
              alternateEmail="abc@greenco.com"
              samlFedId= "1234"
              permissionSetId="1"
              ownedLevels="2,3,7,11"
              timeZone="America/Mexico_City"
            />
       </users>
</call>

elemento de credenciais
Nome da etiqueta		credenciais
Descrição		Todas as chamadas de API devem conter um único elemento de credenciais para identificar o usuário que invoca a API. A chamada à API é então executada como este usuário (qualquer trilha de auditoria ou histórico de ações no sistema mostrará que este usuário executou a ação) e, portanto, o usuário deve ter as permissões necessárias para executar a ação para que a chamada à API funcione. bem-sucedido.
Atributos do elemento
Nome do atributo	Obrigatório?	Valor	Exemplo
login	S	O nome de logon do usuário que invoca o método de API. Este usuário deve ter as permissões necessárias para invocar o método	sampleuser@company.com
senha	S	A senha do usuário que invoca o método de API.	my_password
parâmetros regionais	N	Especifique os parâmetros regionais a serem usados para interpretar números e datas de entrada e para formatar números e datas de saída (usando o separador de milhares, nomes de meses e formatação de data adequados). Os parâmetros regionais também são usados para especificar o idioma em que as mensagens do sistema na resposta devem ser exibidas. Se não especificado, en_US (inglês americano) é usado.	fr_FR
instanceCode	N	Se o usuário especificado nas credenciais tem acesso a mais de uma instância do Adaptive Planning , esse atributo pode ser usado para especificar que o usuário pretende acessar uma instância diferente da instância por padrão. Se não for especificada, a instância por padrão do usuário será usada. Para determinar os códigos de instância disponíveis, use a API exportInstances.	MYINSTANCE1
Conteúdo do elemento
(nenhum)

elemento de usuários
Nome da etiqueta		usuários
Descrição		Contém um ou mais elementos de usuário.
Atributos do elemento
Nome do atributo	Obrigatório?	Valor	Exemplo
Conteúdo do elemento
Contém um ou mais elementos de usuário. Oferece suporte à criação de no máximo 1.000 usuários em uma única solicitação.

elemento de usuário
Nome da etiqueta		usuário
Descrição		Especifica um usuário ou usuários a serem criados.
Atributos do elemento
Nome do atributo	Obrigatório?	Valor	Exemplo
e-mail	S	O endereço de e-mail deste usuário. A exclusividade é obrigatória. Os únicos caracteres permitidos são az, AZ, 0-9, - e .	newUser@company.com
nome	S	O nome deste usuário.	Melvin Morsmere
posição Disponível na API v39+	N	Posição do usuário.	"CEO"
senha	S	A senha deste usuário. Esse atributo é obrigatório, exceto no caso de uma instância conectada ao Workday que tem sincronização de usuário habilitada e usa a SSO SAML do Workday para se conectar ao Adaptive Planning.	newpassword
alternateEmail Disponível na API v27	N	O endereço de e-mail alternativo deste usuário. Selecionamos automaticamente essa opção e a preenchemos com a ID de e-mail do usuário na seção Detalhes do usuário.	abc@greenco.com
samlFedId Disponível na API v27	N	A ID de federação SAML para este usuário.	1234, user@company.com
permissionSetId Disponível na API v25+	N	A ID do sistema interno do conjunto de permissões atribuídas a este usuário.	3
roleId Disponível na API v25 e anteriores Não disponível na API v25+	N	A ID do sistema interno da função atribuída a este usuário. Não há valor por padrão. (O atributo roleId também é coberto na API exportRoles.)	3
ownerLevels	N	A ID do sistema interno para os níveis separados por vírgula. Não há valor por padrão. (O atributo ownerLevels também é coberto pela API exportLevels.)	5,10,13
página inicial Disponível na API v39+	N	Página inicial do usuário.	"Bem-vindo"
timeZone	N	O fuso horário do usuário. Se nada é especificado, o valor por padrão é EUA/Pacífico.	EUA/Pacífico
país Disponível na API v39+	N	Código de país do usuário (código alfa-2).	"EUA"
usState Disponível na API v39+	N	Código do estado do usuário (o país deve ser EUA).	"CA"
netsuiteLogin Disponível na API v39+	N	Logon no Netsuite	"abc@netsuite.com"
salesforceLogin Disponível na API v39+	N	Logon do Salesforce	"abc@salesforce.com"
Conteúdo do elemento
(nenhum)

Formato da resposta


  <?xml version='1.0' encoding='UTF-8'?>
  <response success="true">
     <output>
         <result>
               <created_users>
                   <user success="true" message="user newUser@company.com was created successfully." guid="0CCF69803A990160E063820012ACFDD7"/>
               </created_users>
         </result>
     </output>
</response>

elemento de resposta
Nome da etiqueta		resposta
Atributos do elemento
Nome do atributo	Obrigatório?	Valor	Exemplo
êxito	S	Verdadeiro ou falso, indicando se a chamada à API foi bem-sucedida ou não. Mesmo as chamadas bem-sucedidas podem conter mensagens de aviso na resposta.	verdadeiro
Conteúdo do elemento
Um único elemento de resultado com os elementos de status created_user ou update_user, dependendo se uma chamada a createUser ou updateUser foi feita, respectivamente.

elemento de resultado
Nome da etiqueta		resultado
Descrição		Contêiner para um ou mais elementos de status.
Atributos do elemento
Nome do atributo	Obrigatório?	Valor	Exemplo
(nenhum)
Conteúdo do elemento
Um ou mais elementos de status created_user ou update_user, dependendo se uma chamada a createUser ou updateUser foi feita, respectivamente.

created_users element
Nome da etiqueta		created_users
Descrição		Representa uma mensagem enviada pelo sistema de volta para o autor da chamada.
Atributos do elemento
Nome do atributo	Obrigatório ?	Valor	Exemplo
êxito do usuário	S	O status retornado pela chamada. Pode ser verdadeiro ou falso.	verdadeiro
mensagem	S	A mensagem de status.	usuárionewuser@company.com foi criado com êxito.
guid	S	O GUID do usuário criado.	"0CCF69803A990160E063820012ACFDD7"
Conteúdo do elemento
Um elemento de assinaturas.