GetLoginsforAuthDomain

Short Description

Retrieves the logins for the connected user for the specified authentication domain in order of identity precedence.

Category

Category: Generalized authorization methods

Interface Version

ISecurity 1.1

Syntax

GetLoginsforAuthDomain(credHandle,authDomain,options,output);

Parameters

Method Parameters
Parameter
Type
Direction
Description
credHandle
string
in
A credential handle identifying a user identity, or an empty string.
authDomain
string
in
The name of an AuthenticationDomain, such as DefaultAuth or saspw.
options
string array
in
A two-dimensional string array. Each row contains an option keyword in column zero, and a corresponding value in column one, as described:
MaxListLen
An integer that indicates the maximum number of logins to return. The default value is 1.
IncludeBlankPasswords
A value of Yes specifies to include logins that do not have passwords. A value of No (the default value) specifies to exclude logins that do not have passwords.
PrimaryOnly
A value of Yes specifies to return only logins that are directly associated to the primary identity. A value of No (the default value if this option is omitted) specifies to return logins from group memberships as well.
IdentityInfo
A value of Yes specifies to also return output columns containing the OwnerName, OwnerType, and OwnerId for the owning identity. A value of No (the default value if this option is omitted) specifies not to return this information.
output
string array
out
A two-dimensional string array in which each row represents the information for a login. The default column values returned are the following:
Column 0: UserId
Column 1: Password
Column 2: ObjectId
When IdentityInfo="Yes", also:
Column 3: OwnerName
Column 4: OwnerType
Column 5: OwnerId

Details

CREDHANDLE identifies the user identity for whom logins are being requested. When this value is an empty string, the user identity of the caller is used.
Logins are returned in priority order following identity precedence. For information about identity precedence, see the SAS Intelligence Platform: Security Administration Guide.

Exceptions Thrown

The SAS Open Metadata Interface explicitly returns the following exceptions for the GetLoginsforAuthDomain method:
  • InvalidCredHandle
  • InvalidOptionName
  • InvalidOptionValue
  • AuthDomainDoesNotExist

Related Methods