Identity Information

Identity information describes the directory service, authentication provider, user, or group. As with other API calls, parameters and values are case sensitive. If you are passing a value, copy a sample, and then customize the value to match the exact name or setting in your own environment.

Depending on the API call, input parameters and return values vary.

  • Prefix: Use in conjunction with Name or Universal. Specify the authentication provider:

    • AD+Friendly Name, for example, Prefix: AD+VENAFI.
    • LDAP+Friendly Name, for example, Prefix: LDAP+ENV05.
    • local, for example: Prefix: local.

  • Name: Use only in conjunction with Prefix. A Friendly Name of a person or group. For example, Name: Everyone.

  • Universal: Use only in conjunction with Prefix. The Universally Unique Identifier (UUID) of the user or group identity. The format of the UUID, including the absence or presence of curly braces, depends on the settings from the identity provider. For example, Universal:{20711980-df6e-4813-a6fa-d5930fa37ac8}.

- OR -

  • PrefixedName: Depending on the API call, works as a standalone parameter or in conjunction with PrefixedUniversal. The authentication provider and the Friendly Name of a person or group. Specify one of the following:
    • AD+Friendly Name: For example, PrefixedName: AD+VENAFI:Bill.Dickey.
    • LDAP+Friendly Name: For example, Prefix: LDAP+ENV05:SecurityGroup.
    • local:Friendly Name. For example: Prefix: local:admin.

- OR -

  • PrefixedUniversal: Recommended. Depending on the API call, works as a standalone parameter or in conjunction with PrefixedName. The authentication provider, and the Universally Unique Identifier (UUID) of the user or group identity. The format of the UUID, including the absence or presence of curly braces, depends on the settings from the identity provider. Specify one of the following:

    • AD+Friendly Name:{UUID}. For example, PrefixedUniversal: AD+JHTEST:{20711110-ffff-4813-a6fa-d5930fa37ac8}.
    • LDAP+Friendly Name:{UUID}. For example, PrefixedUniversal: LDAP+SecurityGroup:{88151980-ee6e-2815-z6fa-d5930fa37ff8}.
    • local:{UUID}. For example: PrefixedUniversal: local:{444444e0-303c-d555-afff-8c8cd0cccccc}.