Skip to main content

Details of the user

GET 
/users/:UserEmailOrID

Get information on a specific user by their email

Request​

Path Parameters

    UserEmailOrID UserEmailOrIDrequired

    Possible values: <= 50 characters, Value must match regular expression ^[^<>]*$

    UUID or email address of the user. Note use of the email address is considered deprecated

Header Parameters

    x-fapi-auth-date string

    Possible values: Value must match regular expression ^(Mon|Tue|Wed|Thu|Fri|Sat|Sun), \d{2} (Jan|Feb|Mar|Apr|May|Jun|Jul|Aug|Sep|Oct|Nov|Dec) \d{4} \d{2}:\d{2}:\d{2} (GMT|UTC)$

    The time when the PSU last logged in with the TPP. All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: Sun, 10 Sep 2017 19:43:31 UTC

    x-fapi-customer-ip-address string

    The PSU's IP address if the PSU is currently logged in with the TPP.

    x-fapi-interaction-id string

    An RFC4122 UID used as a correlation id.

    x-customer-user-agent string

    Indicates the user-agent that the PSU is using.

Responses​

Details of the user

Response Headers

  • x-fapi-interaction-id

    string

Schema

    SuperUser boolean

    Is the user a super user

    DataAdministrator boolean

    Is the user a data administrator

    CertificationManager boolean

    Is the user a certification manager

    SystemUser boolean

    Is the user a system user

    BasicInformation

    object

    UserID uuid

    Possible values: <= 40 characters

    The unique ID of a user

    UserEmail string

    Possible values: Value must match regular expression ^[^<>]*$

    Status StatusEnum (string)

    Possible values: [Active, Inactive]

    Default value: Active

    Current status of this resource

    OrgAccessDetails

    object

    Map Key - OrgId, Map Value - Org Access Detail(containing info about org admin and domain role)

    property name*

    OrgAccessDetail

    OrgRegistrationNumber string

    Possible values: Value must match regular expression ^[^<>]*$

    CNPJ/Registration number of the org

    OrganisationName string

    Possible values: <= 255 characters, Value must match regular expression ^[^<>]*$

    Name of the organisation.

    OrgAdmin boolean

    Is the user the org admin of the current org

    DomainRoleDetails

    object[]

    Array of domain, role and status of domain role mapping

  • Array [

    • AuthorisationDomainName string

    Possible values: Value must match regular expression ^[^<>]*$

    AuthorisationDomainRoleName AuthorisationDomainRoleName (string)

    Possible values: non-empty and <= 60 characters, Value must match regular expression ^[^<>]*$

    The authorisation domain role name

    Status StatusEnum (string)

    Possible values: [Active, Inactive]

    Default value: Active

    Current status of this resource

    ContactRole AuthorisationDomainUserTypeName (string)

    Possible values: <= 255 characters, Value must match regular expression ^[^<>]*$

    The name of the authorisation domain user type

    UserTypeID AuthorisationDomainUserTypeID (string)

    Possible values: <= 40 characters, Value must match regular expression ^[^<>]*$

    Unique authorisation domain user type UUID

    System AuthorisationDomainSystemName (string)

    Possible values: <= 255 characters, Value must match regular expression ^[^<>]*$

    The name of the authorisation domain user type

  • ]

    • DirectoryTermsAndConditionsDetails

    object

    Details of TnC

    RequiresSigning boolean

    Does the Directory TnC require signing

    Updated boolean

    Has the document updated since the user signed

    TermsAndConditionsItem

    object

    ExternalSigningService

    object

    ExternalSigningServiceName ExternalSigningServiceName (string)

    Possible values: [DocuSign]

    The Name of the External Signing Service

    ExternalSigningServiceSignerTemplateConfig

    object

    Signer1TemplateId string

    Possible values: non-empty, Value must match regular expression ^[^<>]*$

    Template ID for 1 signer

    Signer1Version integer

    Version of the TnC document

    Signer2TemplateId string

    Possible values: non-empty, Value must match regular expression ^[^<>]*$

    Template ID for 2 signers

    Signer2Version integer

    Version of the TnC document

    Signer3TemplateId string

    Possible values: non-empty, Value must match regular expression ^[^<>]*$

    Template ID for 3 signers

    Signer3Version integer

    Version of the TnC document

    Signer4TemplateId string

    Possible values: non-empty, Value must match regular expression ^[^<>]*$

    Template ID for 4 signers

    Signer4Version integer

    Version of the TnC document

    Signer5TemplateId string

    Possible values: non-empty, Value must match regular expression ^[^<>]*$

    Template ID for 5 signers

    Signer5Version integer

    Version of the TnC document

    Signer6TemplateId string

    Possible values: non-empty, Value must match regular expression ^[^<>]*$

    Template ID for 6 signers

    Signer6Version integer

    Version of the TnC document

    ExternalSigningServiceSubject string

    Possible values: non-empty, Value must match regular expression ^[^<>]*$

    The Subject of the External Signing Service

    ExternalSigningServiceEmailSubject string

    Possible values: non-empty and <= 100 characters, Value must match regular expression ^[^<>]*$

    The Subject of the Email for External Signing Service

    Version integer

    Version of the TnC

    TnCId integer

    Unique identifier for the Terms and Conditions Item

    Name stringrequired

    Possible values: non-empty, Value must match regular expression ^[^<>]*$

    The Name of the TnC

    Type stringrequired

    Possible values: [Participant, Directory]

    Role for which this TnC applies

    Content stringrequired

    Possible values: non-empty, Value must match regular expression ^[^<>]*$

    The MarkDown of the TnC

    Status StatusEnum (string)

    Possible values: [Active, Inactive]

    Default value: Active

    Current status of this resource

    CreatedAt date-time
    UpdatedAt date-time
Loading...