Create Unauthenticated Access User

Create Unauthenticated Access User

All the listed privileges are required -

Privileges	Description
GLOBAL_CONFIG_MANAGEMENT	Caller should have permission to this privilege to manage unauthenticated access user(s).
FEDERATED_LDAP_MANAGE	If CPA is enabled, caller should have permission to this privilege to manage unauthenticated access user(s).

Request

URI

POST

https://{api_host}/rest/config/v1/unauthenticated-access-users

COPY

Request Body

UnauthenticatedAccessUserCreateSpec of type(s) application/json

Required

Show optional properties

{
    "user_id": "S-1-5-21-1111111111-2222222222-3333333333-500"
}

{
    "alias_name": "unauthenticated-user",
    "description": "example description",
    "hybrid_logon_mode": "PASSWORD",
    "hybrid_logon_password": [
        "password"
    ],
    "user_id": "S-1-5-21-1111111111-2222222222-3333333333-500"
}

string

alias_name

Optional

Alias to be used for login from client. If unset, AD login name of the user would be used.

string

description

Optional

Description of the unauthenticated access user.

string

hybrid_logon_mode

Optional

Mode to be used for hybrid logon. If unset, hybrid logon will be disabled.

PASSWORD: Hybrid logon via username and password.
TRUESSO: Hybrid logon via True SSO.
DISABLED: Hybrid logon disabled.

Possible values are : PASSWORD, TRUESSO, DISABLED,

array of string

hybrid_logon_password

Optional

Password for the user for hybrid logon. This is required when hybrid_logon_mode is set to PASSWORD.

string

user_id

Required

SID of the user for whom unauthenticated access is to be configured.

Authentication

This operation uses the following authentication methods.

Responses

201

Created

Operation doesn't return any data structure

400

Bad Request

Operation doesn't return any data structure

401

User is not authenticated

Operation doesn't return any data structure

403

Access to the resource is forbidden

Operation doesn't return any data structure

404

Not Found

Operation doesn't return any data structure

409

Conflict

Operation doesn't return any data structure

Code Samples

COPY

                    curl -X POST -H 'Authorization: <value>' -H 'Content-Type: application/json' -d '{"user_id:"string"}' https://{api_host}/rest/config/v1/unauthenticated-access-users

On This Page

Description

Request

Request Body

Authentication

Response

201 Response Body

Errors

Config Operations

Get Admin Users Or Groups Permissions

Get Preferences

Update Preferences

List App Volumes Managers

Add App Volumes Manager

Validate AVM Certificate

Delete App Volumes Manager

Get App Volumes Manager

Update App Volumes Manager

Override Certificate

Push Certificates

Update CEIP Info

List Connection Servers

Delete Certificate

Disable Connection Servers

Enable Connection Servers

Export Certificate

Import Certificate

Recover Certificates

List Certificate Infos

Get Security Configuration Info

Get Connection Server

Update Connection Server

Get Environment

Get Event Database

Update Event Database

Clear Event Database

List Federation Access Groups

Create Federation Access Group

Delete Federation Access Group

Get Federation Access Group

Delete Gateway Access User Or Group

List Gateway Access User Or Group

Create Gateway Access User Or Group

Register Gateway

Unregister Gateway

Get Global Policies

Update Global Policies

List GSSAPI Authenticators

Create GSSAPI Authenticator

Delete GSSAPI Authenticator

Get GSSAPI Authenticator

Update GSSAPI Authenticator

List IC Domain Accounts

Create IC Domain Account

Delete IC Domain Account

Get IC Domain Account

Update IC Domain Account

Get AD Sites Info

Create IM Asset

Create IM Assets

Delete IM Asset

Update IM Asset

List IM Streams

Create IM Stream

Create IM Streams

Delete IM Stream

Update IM Stream

List IM Versions

Create IM Version

Create IM Versions

Delete IM Version

Update IM Version

List JWT Authenticators

Create JWT Authenticator

Delete JWT Authenticator

Get JWT Authenticator

Update JWT Authenticator

Reset Highest Usage Metrics

Reset Named User Metrics

Set License Mode

List Local Access Groups

Create Local Access Group

Delete Local Access Group

Get Local Access Group

List Log Collector Tasks

Generate Download UR Ls

List Message Clients

Create Message Client

Delete Message Client

Get Message Client

Update Message Client

Delete Permissions

List Permissions

Create Permissions

Get Pre Logon Settings

List Selectable Privileges

List RADIUS Authenticators

Create RADIUS Authenticator

Delete RADIUS Authenticator

Get RADIUS Authenticator

Update RADIUS Authenticator

Register RCX Client

Unregister RCX Client

Update RCX Client

List RCX Servers

List SAML Authenticators

Create SAML Authenticator

Validate SAML Certificate

Delete SAML Authenticator

Get SAML Authenticator

Update SAML Authenticator

List Secondary Credentials

Create Secondary Credential

Delete Secondary Credential

Get Secondary Credentials

Update Settings

Get Agent Restriction Settings

Update Agent Restriction Settings

Get Client Settings

Update Client Settings

Get Feature Settings

Update Feature Settings

Get General Settings

Update General Settings

Get Security Settings

Update Security Settings

List True SSO Connectors

Create True SSO Connector

List Enrollment Servers

Get Enrollment Server

Delete True SSO Connector

Get True SSO Connector

Update True SSO Connector

List Unauthenticated Access Users

Create Unauthenticated Access User

Delete Unauthenticated Access User

Get Unauthenticated Access User

List Users Or Groups Global Summary

Get Users Or Groups Global Summary

List Users Or Groups Local Summary

Get Storage Details

Validate Virtual Center Certificate

Mark Datastores For Archival

Get Preferences V2

Update Preferences V2

List App Volumes Managers V2

Add App Volumes Manager V2

Delete App Volumes Manager V2

Get App Volumes Manager V2

Update App Volumes Manager V2

List Connection Servers V2

List Certificate Infos V2

Get Connection Server V2

Update Connection Server V2

Get Environment V2

List Federation Access Groups V2

Get Federation Access Group V2

List Licenses V2

Set License Key

List Local Access Groups V2

Get Local Access Group V2

Delete Permissions V2

List Permissions V2

Create Permissions V2

Get Permission V2

Get Settings V2

Update Settings V2

Get Feature Settings V2

Update Feature Settings V2

Get General Settings V2

Update General Settings V2

Get Security Settings V2

List Users Or Groups Local Summary V2

Get Users Or Group Local Summary V2

List VC Info V2

Get Settings V3

Update Settings V3

Get General Settings V3

Update General Settings V3

Get Security Settings V3

Update Security Settings V3

List Users Or Groups Local Summary V3

Get Users Or Group Local Summary V3

List VC Info V3

Create Virtual Center

Remove Virtual Center

Get Virtual Center

Update Virtual Center

Get Settings V4

Update Settings V4

Get General Settings V4

Update General Settings V4

Get Security Settings V4

Update Security Settings V4

List Users Or Groups Local Summary V4

Get Users Or Group Local Summary V4

List VC Info V4

Create Virtual Center V4

Get Virtual Center V4

Update Virtual Center V4

Get Settings V5

Update Settings V5

Get General Settings V5

Update General Settings V5

Get Security Settings V5

Update Security Settings V5

List VC Info V5

Create Virtual Center V5

Remove Virtual Center V5

Get Virtual Center V5

Update Virtual Center V5

Get Settings V6

Update Settings V6

List VC Info V6

Node: apidepo-liferay-dxp-v1-be-w-0:8080: